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

List organization artifacts

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

List organization artifacts.

Pagination. Use limit, cursor to page through results. See pagination.

Авторизация

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.

Параметры запроса

kindstringНеобязательныйone of: "image", "video", "text", "document", "file", "all"
projectIdstring (uuid)Необязательный
agentIdstring (uuid)Необязательный
qstringНеобязательныйat most 160 characters
groupBystringНеобязательныйone of: "none", "task", "parent_task"
groupIssueIdstring (uuid)Необязательный
starredanyНеобязательный
limitintegerНеобязательный≥ 1≤ 100
cursorstringНеобязательныйat least 1 character

Ответы

200Organization artifact projectionThe 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. Подробнее: ошибки и ограничения.

Organizations