Справочник API публикуется на английском языке.

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 TeamОбновлено Версия 3 · История

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

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

providerstringОбязательныйone of: "anthropic", "openai", "openrouter", "xai", "github", "google"
methodstringОбязательныйone of: "subscription", "api_key"
namestringОбязательный1–160 characters
ownershipstringОбязательныйone of: "personal", "shared"
routingobjectНеобязательный
routing.kindstringОбязательныйone of: "openrouter", "bedrock", "gateway", "local"
routing.protocolstringОбязательныйone of: "responses", "messages", "chat", "bedrock"
routing.baseUrlstringНеобязательныйat most 2048 characters
routing.authstringНеобязательныйone of: "bearer", "api_key", "none"
routing.regionstringНеобязательныйpattern: ^[a-z]{2}(?:-[a-z]+)+-\d$
routing.modelsarray<object>Необязательный
routing.models[].idstringОбязательный1–256 characters
routing.models[].labelstringНеобязательныйat most 160 characters
apiKeystringНеобязательный1–32768 characters
environmentIdstring (uuid) | nullНеобязательный
loginSessionIdstringНеобязательныйat most 128 characters
connectionIdstring (uuid)Необязательный
agentIdsarray<string (uuid)>Необязательный
allAgentsbooleanНеобязательный

Ответы

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).

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

AI connections