La referencia de la API se publica en inglés.
Validate and connect an AI API key, or reconnect its existing grant
POST
/api/companies/{companyId}/ai-connectionsPersonal API keyAgent API keyConsole session
Validate and connect an AI API key, or reconnect its existing grant.
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
providerstringObligatorio
one of: "anthropic", "openai", "openrouter", "xai", "github", "google"methodstringObligatorio
one of: "subscription", "api_key"namestringObligatorio
1–160 charactersownershipstringObligatorio
one of: "personal", "shared"routingobjectOpcional
routing.kindstringObligatorio
one of: "openrouter", "bedrock", "gateway", "local"routing.protocolstringObligatorio
one of: "responses", "messages", "chat", "bedrock"routing.baseUrlstringOpcional
at most 2048 charactersrouting.authstringOpcional
one of: "bearer", "api_key", "none"routing.regionstringOpcional
pattern: ^[a-z]{2}(?:-[a-z]+)+-\d$routing.modelsarray<object>Opcional
routing.models[].idstringObligatorio
1–256 charactersrouting.models[].labelstringOpcional
at most 160 charactersapiKeystringOpcional
1–32768 charactersenvironmentIdstring (uuid) | nullOpcional
loginSessionIdstringOpcional
at most 128 charactersconnectionIdstring (uuid)Opcional
agentIdsarray<string (uuid)>Opcional
allAgentsbooleanOpcional
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.