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

Verify and save an owned local subscription sign-in

POST/api/companies/{companyId}/ai-connections/local
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Verify and save an owned local subscription sign-in.

Авторизация

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", "xai", "google"
methodstringОбязательныйone of: "subscription"
namestringОбязательный1–160 characters
ownershipstringОбязательныйone of: "personal", "shared"
connectionIdstring (uuid)Необязательный
agentIdsarray<string (uuid)>Необязательный
allAgentsbooleanНеобязательный
localSessionIdstring (uuid)Необязательный

Ответы

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