API referansı İngilizce yayımlanır.

Validate and connect an AI API key, or reconnect its existing grant

POST/api/companies/{companyId}/ai-connections
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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

providerstringZorunluone of: "anthropic", "openai", "openrouter", "xai", "github", "google"
methodstringZorunluone of: "subscription", "api_key"
namestringZorunlu1–160 characters
ownershipstringZorunluone of: "personal", "shared"
routingobjectİsteğe bağlı
routing.kindstringZorunluone of: "openrouter", "bedrock", "gateway", "local"
routing.protocolstringZorunluone of: "responses", "messages", "chat", "bedrock"
routing.baseUrlstringİsteğe bağlıat most 2048 characters
routing.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[].idstringZorunlu1–256 characters
routing.models[].labelstringİsteğe bağlıat most 160 characters
apiKeystringİsteğe bağlı1–32768 characters
environmentIdstring (uuid) | nullİsteğe bağlı
loginSessionIdstringİsteğe bağlıat most 128 characters
connectionIdstring (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.

AI connections