La referencia de la API se publica en inglés.

Create a tool connection

POST/api/companies/{companyId}/tools/connections
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

agentInstructionsobject | nullOpcional
agentInstructions.enabledbooleanObligatorio
agentInstructions.textstringObligatorio1–2000 characters
agentInstructions.templateobjectOpcional
agentInstructions.template.idstringObligatorio1–160 characters
agentInstructions.template.versionintegerObligatorio> 0
applicationIdstring (uuid)Opcional
applicationNamestringOpcional1–160 characters
namestringObligatorio1–160 characters
connectionPurposestringOpcionalone of: "tool", "channel"
transportstringOpcionalone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringOpcionalone of: "oauth", "api_key", "none"
credentialPolicystringOpcionalone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringOpcionalone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringOpcionalone of: "draft", "active", "disabled", "archived"
connectionKindstringOpcionalone of: "managed"
configobjectOpcional
transportConfigobjectOpcional
credentialRefsarray<object>Opcional
credentialRefs[].namestringObligatorio1–120 characters
credentialRefs[].secretIdstring (uuid)Obligatorio
credentialRefs[].versionstring | integerOpcional
credentialRefs[].placementstringObligatorioone of: "header", "env", "url"
credentialRefs[].keystringObligatorio1–160 characters
credentialRefs[].prefixstring | nullOpcionalat most 120 characters
credentialSecretRefsarray<object>Opcional
credentialSecretRefs[].secretIdstring (uuid)Obligatorio
credentialSecretRefs[].versionSelectorstring | integerOpcional
credentialSecretRefs[].configPathstringObligatorio1–200 characters
credentialSecretRefs[].requiredbooleanOpcional
credentialSecretRefs[].labelstring | nullOpcionalat most 120 characters
credentialSecretRefs[].projectionClassstringOpcionalone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullOpcional1–160 characters
credentialSecretRefs[].keyScopestringOpcional1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)Opcional
enabledbooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Connectors