API referansı İngilizce yayımlanır.

Create a tool connection

POST/api/companies/{companyId}/tools/connections
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

agentInstructionsobject | nullİsteğe bağlı
agentInstructions.enabledbooleanZorunlu
agentInstructions.textstringZorunlu1–2000 characters
agentInstructions.templateobjectİsteğe bağlı
agentInstructions.template.idstringZorunlu1–160 characters
agentInstructions.template.versionintegerZorunlu> 0
applicationIdstring (uuid)İsteğe bağlı
applicationNamestringİsteğe bağlı1–160 characters
namestringZorunlu1–160 characters
connectionPurposestringİsteğe bağlıone of: "tool", "channel"
transportstringİsteğe bağlıone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringİsteğe bağlıone of: "oauth", "api_key", "none"
credentialPolicystringİsteğe bağlıone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringİsteğe bağlıone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringİsteğe bağlıone of: "draft", "active", "disabled", "archived"
connectionKindstringİsteğe bağlıone of: "managed"
configobjectİsteğe bağlı
transportConfigobjectİsteğe bağlı
credentialRefsarray<object>İsteğe bağlı
credentialRefs[].namestringZorunlu1–120 characters
credentialRefs[].secretIdstring (uuid)Zorunlu
credentialRefs[].versionstring | integerİsteğe bağlı
credentialRefs[].placementstringZorunluone of: "header", "env", "url"
credentialRefs[].keystringZorunlu1–160 characters
credentialRefs[].prefixstring | nullİsteğe bağlıat most 120 characters
credentialSecretRefsarray<object>İsteğe bağlı
credentialSecretRefs[].secretIdstring (uuid)Zorunlu
credentialSecretRefs[].versionSelectorstring | integerİsteğe bağlı
credentialSecretRefs[].configPathstringZorunlu1–200 characters
credentialSecretRefs[].requiredbooleanİsteğe bağlı
credentialSecretRefs[].labelstring | nullİsteğe bağlıat most 120 characters
credentialSecretRefs[].projectionClassstringİsteğe bağlıone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullİsteğe bağlı1–160 characters
credentialSecretRefs[].keyScopestringİsteğe bağlı1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)İsteğe bağlı
enabledbooleanİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Connectors