La référence de l'API est publiée en anglais.

Bind an existing organization secret to an agent's environment variable, or propose a new organization…

POST/api/agents/me/secret-proposals
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Bind an existing organization secret to an agent's environment variable, or propose a new organization secret, for board approval.

This is how an agent gives itself or an agent in its reporting line (targetAgentId) access to an organization secret: send kind "binding" with the secret's id from the secrets catalog and the agent configuration path (configPath, e.g. env.DEPLOY_API_KEY). Agents cannot PATCH agent configuration with secret refs; a board member approves the proposal, which applies the binding. Send kind "secret" to propose storing a new value.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Corps de la requête

application/json · obligatoire

kindstringObligatoireWhich kind of object this is; it decides which other fields apply.one of: "secret", "binding"
namestringFacultatifRequired with kind: "secret".at least 1 character
descriptionstring | nullFacultatifOnly with kind: "secret".
valuestringFacultatifRequired with kind: "secret".at least 1 character
justificationstringObligatoireat least 1 character
secretIdstring (uuid)FacultatifOnly with kind: "binding".
sourceConfigPathstringFacultatifOnly with kind: "binding".at least 1 character
secretProposalIdstring (uuid)FacultatifOnly with kind: "binding".
targetAgentIdstring (uuid)FacultatifOnly with kind: "binding".
configPathstringFacultatifRequired with kind: "binding".at least 1 character

Réponses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Secrets