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

Start machine sign-in (OAuth client credentials) for an organization connection

POST/api/companies/{companyId}/tools/machine-sign-in
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 4 · История

Start machine sign-in (OAuth client credentials) for an organization connection.

Creates a draft organization connection to a remote MCP server that signs in as a registered client, with no person involved. With method veyra_key, Veyra Intelligence creates a signing key, keeps the private half in the organization vault, and returns the public key to register with the provider. Secrets are write-only.

Авторизация

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 · обязательно

linkstring (uri)Обязательныйat most 4096 characters
namestringНеобязательный1–160 characters
authorizationServerstring (uri)Необязательныйat most 4096 characters
methodstringОбязательныйone of: "veyra_key", "client_secret"
clientIdstringНеобязательный1–4096 characters
clientSecretstringНеобязательный1–16384 characters
scopesstringНеобязательныйat most 2048 characters
applicationIdstring (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. Подробнее: ошибки и ограничения.

Connectors