Create a tool connection

POST/api/companies/{companyId}/tools/connections
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

agentInstructionsobject | nullOptional
agentInstructions.enabledbooleanRequired
agentInstructions.textstringRequired1–2000 characters
agentInstructions.templateobjectOptional
agentInstructions.template.idstringRequired1–160 characters
agentInstructions.template.versionintegerRequired> 0
applicationIdstring (uuid)Optional
applicationNamestringOptional1–160 characters
namestringRequired1–160 characters
connectionPurposestringOptionalone of: "tool", "channel"
transportstringOptionalone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringOptionalone of: "oauth", "api_key", "none"
credentialPolicystringOptionalone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringOptionalone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringOptionalone of: "draft", "active", "disabled", "archived"
connectionKindstringOptionalone of: "managed"
configobjectOptional
transportConfigobjectOptional
credentialRefsarray<object>Optional
credentialRefs[].namestringRequired1–120 characters
credentialRefs[].secretIdstring (uuid)Required
credentialRefs[].versionstring | integerOptional
credentialRefs[].placementstringRequiredone of: "header", "env", "url"
credentialRefs[].keystringRequired1–160 characters
credentialRefs[].prefixstring | nullOptionalat most 120 characters
credentialSecretRefsarray<object>Optional
credentialSecretRefs[].secretIdstring (uuid)Required
credentialSecretRefs[].versionSelectorstring | integerOptional
credentialSecretRefs[].configPathstringRequired1–200 characters
credentialSecretRefs[].requiredbooleanOptional
credentialSecretRefs[].labelstring | nullOptionalat most 120 characters
credentialSecretRefs[].projectionClassstringOptionalone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullOptional1–160 characters
credentialSecretRefs[].keyScopestringOptional1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)Optional
enabledbooleanOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Connectors