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.
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
providerstringRequired
one of: "anthropic", "openai", "openrouter", "xai", "github", "google"methodstringRequired
one of: "subscription", "api_key"namestringRequired
1–160 charactersownershipstringRequired
one of: "personal", "shared"routingobjectOptional
routing.kindstringRequired
one of: "openrouter", "bedrock", "gateway", "local"routing.protocolstringRequired
one of: "responses", "messages", "chat", "bedrock"routing.baseUrlstringOptional
at most 2048 charactersrouting.authstringOptional
one of: "bearer", "api_key", "none"routing.regionstringOptional
pattern: ^[a-z]{2}(?:-[a-z]+)+-\d$routing.modelsarray<object>Optional
routing.models[].idstringRequired
1–256 charactersrouting.models[].labelstringOptional
at most 160 charactersapiKeystringOptional
1–32768 charactersenvironmentIdstring (uuid) | nullOptional
loginSessionIdstringOptional
at most 128 charactersconnectionIdstring (uuid)Optional
agentIdsarray<string (uuid)>Optional
allAgentsbooleanOptional
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Errors return {"error": "..."}, often with a code and details. See errors and limits.