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

Connect a person's terminal to Veyra Intelligence: create a CLI auth challenge for terminal login

POST/api/cli-auth/challenges
No API key
Veyra Docs TeamОбновлено Версия 4 · История

Connect a person's terminal to Veyra Intelligence: create a CLI auth challenge for terminal login.

Called by the Veyra Intelligence CLI in a person's own terminal, never by an agent on their behalf. To connect someone's terminal to Veyra Intelligence as themselves, tell them to run veyra auth login --api-base <this Veyra URL> in that terminal (add --company-id <companyId> to name the organization). The URL is the address the person already opens Veyra Intelligence at in their browser; leave it as that placeholder instead of looking it up, because addresses an agent can see (such as a runner-local API URL) may not be reachable from the person's machine. The CLI prints an approval link; they open it in a browser where they are signed in, review the requesting command, organization and Board access, and approve. Only that CLI receives the resulting personal credential. veyra auth whoami confirms who it is signed in as and veyra auth logout revokes it. Agent API keys are a separate identity: never hand out an agent key, create or approve a challenge yourself, or ask for the person's password in chat.

Авторизация

No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Как работают ключи.

Тело запроса

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

commandstringОбязательный1–240 characters
clientNamestring | nullНеобязательныйat most 120 characters
requestedAccessstringНеобязательныйone of: "board", "instance_admin_required"
requestedCompanyIdstring (uuid) | nullНеобязательный

Ответы

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.

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

Members, invites and keys