Справочник API публикуется на английском языке.
Update a tool connection
PATCH
/api/tool-connections/{connectionId}Personal API keyAgent API keyConsole session
Update a tool connection.
Авторизация
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. Как работают ключи.
Параметры пути
connectionIdstringОбязательныйThe connection's id.
Тело запроса
application/json · обязательно
agentInstructionsobject | nullНеобязательный
agentInstructions.enabledbooleanОбязательный
agentInstructions.textstringОбязательный
1–2000 charactersagentInstructions.templateobjectНеобязательный
agentInstructions.template.idstringОбязательный
1–160 charactersagentInstructions.template.versionintegerОбязательный
> 0applicationNamestringНеобязательный
1–160 charactersnamestringНеобязательный
1–160 charactersconnectionPurposestringНеобязательный
one of: "tool", "channel"transportstringНеобязательный
one of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"authKindstringНеобязательный
one of: "oauth", "api_key", "none"credentialPolicystringНеобязательный
one of: "shared", "per_user", "per_user_with_fallback", "per_agent"ownershipstringНеобязательный
one of: "platform_shared", "platform_provisioned", "customer", "dcr"statusstringНеобязательный
one of: "draft", "active", "disabled", "archived"connectionKindstringНеобязательный
one of: "managed"configobjectНеобязательный
transportConfigobjectНеобязательный
credentialRefsarray<object>Необязательный
credentialRefs[].namestringОбязательный
1–120 characterscredentialRefs[].secretIdstring (uuid)Обязательный
credentialRefs[].versionstring | integerНеобязательный
credentialRefs[].placementstringОбязательный
one of: "header", "env", "url"credentialRefs[].keystringОбязательный
1–160 characterscredentialRefs[].prefixstring | nullНеобязательный
at most 120 characterscredentialSecretRefsarray<object>Необязательный
credentialSecretRefs[].secretIdstring (uuid)Обязательный
credentialSecretRefs[].versionSelectorstring | integerНеобязательный
credentialSecretRefs[].configPathstringОбязательный
1–200 characterscredentialSecretRefs[].requiredbooleanНеобязательный
credentialSecretRefs[].labelstring | nullНеобязательный
at most 120 characterscredentialSecretRefs[].projectionClassstringНеобязательный
one of: "unclassified", "class_3_static_lease"credentialSecretRefs[].projectionAllowlistKeystring | nullНеобязательный
1–160 characterscredentialSecretRefs[].keyScopestringНеобязательный
1–160 characterscredentialSecretRefs[].expiresAtstring (date-time)Необязательный
enabledbooleanНеобязательный
Ответы
200SuccessThe request worked; the body holds the result.
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.