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

Create a tool connection

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

Create a tool connection.

Saves a connection as given without checking that its server answers. To connect an MCP server from its URL, use POST /api/companies/{companyId}/tools/apps/connect with link instead: it checks the server first, and a fresh setup saves no connection when the server cannot be reached. 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

agentInstructionsobject | nullFacultatif
agentInstructions.enabledbooleanObligatoire
agentInstructions.textstringObligatoire1–2000 characters
agentInstructions.templateobjectFacultatif
agentInstructions.template.idstringObligatoire1–160 characters
agentInstructions.template.versionintegerObligatoire> 0
applicationIdstring (uuid)Facultatif
applicationNamestringFacultatif1–160 characters
namestringObligatoire1–160 characters
connectionPurposestringFacultatifone of: "tool", "channel"
transportstringFacultatifone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringFacultatifone of: "oauth", "api_key", "none"
credentialPolicystringFacultatifone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringFacultatifone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringFacultatifone of: "draft", "active", "disabled", "archived"
connectionKindstringFacultatifone of: "managed"
configobjectFacultatif
transportConfigobjectFacultatif
credentialRefsarray<object>Facultatif
credentialRefs[].namestringObligatoire1–120 characters
credentialRefs[].secretIdstring (uuid)Obligatoire
credentialRefs[].versionstring | integerFacultatif
credentialRefs[].placementstringObligatoireone of: "header", "env", "url"
credentialRefs[].keystringObligatoire1–160 characters
credentialRefs[].prefixstring | nullFacultatifat most 120 characters
credentialSecretRefsarray<object>Facultatif
credentialSecretRefs[].secretIdstring (uuid)Obligatoire
credentialSecretRefs[].versionSelectorstring | integerFacultatif
credentialSecretRefs[].configPathstringObligatoire1–200 characters
credentialSecretRefs[].requiredbooleanFacultatif
credentialSecretRefs[].labelstring | nullFacultatifat most 120 characters
credentialSecretRefs[].projectionClassstringFacultatifone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullFacultatif1–160 characters
credentialSecretRefs[].keyScopestringFacultatif1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)Facultatif
enabledbooleanFacultatif

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.
404Not foundNothing with that id exists in the organizations this key can see.

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

Connectors