La référence de l'API est publiée en anglais.
Update a tool connection
PATCH
/api/tool-connections/{connectionId}Personal API keyAgent API keyConsole session
Update a tool connection.
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
connectionIdstringObligatoireThe connection's id.
Corps de la requête
application/json · obligatoire
agentInstructionsobject | nullFacultatif
agentInstructions.enabledbooleanObligatoire
agentInstructions.textstringObligatoire
1–2000 charactersagentInstructions.templateobjectFacultatif
agentInstructions.template.idstringObligatoire
1–160 charactersagentInstructions.template.versionintegerObligatoire
> 0applicationNamestringFacultatif
1–160 charactersnamestringFacultatif
1–160 charactersconnectionPurposestringFacultatif
one of: "tool", "channel"transportstringFacultatif
one of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"authKindstringFacultatif
one of: "oauth", "api_key", "none"credentialPolicystringFacultatif
one of: "shared", "per_user", "per_user_with_fallback", "per_agent"ownershipstringFacultatif
one of: "platform_shared", "platform_provisioned", "customer", "dcr"statusstringFacultatif
one of: "draft", "active", "disabled", "archived"connectionKindstringFacultatif
one of: "managed"configobjectFacultatif
transportConfigobjectFacultatif
credentialRefsarray<object>Facultatif
credentialRefs[].namestringObligatoire
1–120 characterscredentialRefs[].secretIdstring (uuid)Obligatoire
credentialRefs[].versionstring | integerFacultatif
credentialRefs[].placementstringObligatoire
one of: "header", "env", "url"credentialRefs[].keystringObligatoire
1–160 characterscredentialRefs[].prefixstring | nullFacultatif
at most 120 characterscredentialSecretRefsarray<object>Facultatif
credentialSecretRefs[].secretIdstring (uuid)Obligatoire
credentialSecretRefs[].versionSelectorstring | integerFacultatif
credentialSecretRefs[].configPathstringObligatoire
1–200 characterscredentialSecretRefs[].requiredbooleanFacultatif
credentialSecretRefs[].labelstring | nullFacultatif
at most 120 characterscredentialSecretRefs[].projectionClassstringFacultatif
one of: "unclassified", "class_3_static_lease"credentialSecretRefs[].projectionAllowlistKeystring | nullFacultatif
1–160 characterscredentialSecretRefs[].keyScopestringFacultatif
1–160 characterscredentialSecretRefs[].expiresAtstring (date-time)Facultatif
enabledbooleanFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.