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

List secret metadata (id, name, key, status) — accessible to agents

GET/api/companies/{companyId}/secrets/catalog
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

List secret metadata (id, name, key, status) — accessible to agents.

Discover stored organization credential metadata, never values. To add an organization credential, direct the human to the organization-prefixed /company/settings/secrets page and New secret, then bind only the intended agent's environment reference in its configuration. Secure storage of an already-requested key does not require connecting a new external service. Never request the value in chat or claim it is saved or bound before observing the authorized changes.

Авторизация

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.

Ответы

200SuccessThe request worked; the body holds the result.
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.

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

Secrets