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

Create a draft app connection from gallery input

POST/api/companies/{companyId}/tools/apps/connect
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

Create a draft app connection from gallery input.

When a person's own MCP server needs an API key, the person adds it themselves on Connect your own MCP server: they enter its URL and type the key into that page's secure field. An agent cannot enter the key and must not ask for it in chat. Link that page and reply instead of creating the connection here.

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.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

workspaceServicesobjectFacultatif
workspaceServices.gmailstringFacultatifone of: "read", "write"
workspaceServices.drivestringFacultatifone of: "read", "write"
workspaceServices.calendarstringFacultatifone of: "read", "write"
agentInstructionsobject | nullFacultatif
agentInstructions.enabledbooleanObligatoire
agentInstructions.textstringObligatoire1–2000 characters
agentInstructions.templateobjectFacultatif
agentInstructions.template.idstringObligatoire1–160 characters
agentInstructions.template.versionintegerObligatoire> 0
galleryKeystringFacultatif1–120 characters
connectionMethodKeystringFacultatif1–120 characters
linkstring (uri)Facultatifat most 2000 characters
namestringFacultatif1–160 characters
credentialValuesobject<string, string>Facultatif
configValuesobjectFacultatif
applicationIdstring (uuid)Facultatif
interactionIdstring (uuid)Facultatif
resumeConnectionIdstring (uuid)Facultatif
reconnectConnectionIdstring (uuid)Facultatif
saveDraftbooleanFacultatif
authModestringFacultatifone of: "auto", "none", "bearer", "custom_headers", "oauth"
oauthClientobjectFacultatif
oauthClient.clientIdstringObligatoire1–4096 characters
oauthClient.clientSecretstringFacultatif1–16384 characters
credentialSourcestringFacultatifone of: "veyra_vault", "vercel_connect"
vercelConnectobjectFacultatif
vercelConnect.connectorstringObligatoire1–255 characters
grantKindstringFacultatifone of: "organization", "user", "agent"
subjectAgentIdstring (uuid)Facultatif

Réponses

200SuccessThe request worked; the body holds the result.
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.
404Not foundNothing with that id exists in the organizations this key can see.
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.

Connectors