API referansı İngilizce yayımlanır.
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.
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
providerstringZorunlu
one of: "anthropic", "openai", "openrouter", "xai", "github", "google"methodstringZorunlu
one of: "subscription", "api_key"namestringZorunlu
1–160 charactersownershipstringZorunlu
one of: "personal", "shared"routingobjectİsteğe bağlı
routing.kindstringZorunlu
one of: "openrouter", "bedrock", "gateway", "local"routing.protocolstringZorunlu
one of: "responses", "messages", "chat", "bedrock"routing.baseUrlstringİsteğe bağlı
at most 2048 charactersrouting.authstringİsteğe bağlı
one of: "bearer", "api_key", "none"routing.regionstringİsteğe bağlı
pattern: ^[a-z]{2}(?:-[a-z]+)+-\d$routing.modelsarray<object>İsteğe bağlı
routing.models[].idstringZorunlu
1–256 charactersrouting.models[].labelstringİsteğe bağlı
at most 160 charactersapiKeystringİsteğe bağlı
1–32768 charactersenvironmentIdstring (uuid) | nullİsteğe bağlı
loginSessionIdstringİsteğe bağlı
at most 128 charactersconnectionIdstring (uuid)İsteğe bağlı
agentIdsarray<string (uuid)>İsteğe bağlı
allAgentsbooleanİ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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.