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

Start or hand off a case using its primary task

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

Start or hand off a case using its primary task.

Requires enableCases and standard work mode. Kickoff requires either workflowId or workflow_document_text. Workflows are reusable name-and-prompt definitions; phases are free text. On later agent handoffs, omit workflowId to preserve instructions, supply an ID to adopt its latest prompt (including refresh of the current ID), or null to detach while keeping instructions. Acceptance snapshots the selected prompt. Transfer applies workflow, phase and task-document revision together after outgoing execution settles; a document revision conflict holds the handoff for recovery. Workflow and other initial document bodies together must total at most 200000 characters. Inline callers remain supported. Current organization, case, task assignment, source-trust and run authority apply. Reuses the primary task; self-handoffs also yield. An idempotent replay returns the existing authorized receipt.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Авторизация

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 (uuid)ОбязательныйThe organization's id.

Тело запроса

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

toanyНеобязательный
idempotencyKeystringОбязательный1–240 characters
caseobjectОбязательный
case.createobjectОбязательный
case.create.caseTypestringОбязательный1–120 characters
case.create.titlestringОбязательный1–500 characters
case.create.summarystringНеобязательныйat most 8000 characters
case.create.fieldsobjectНеобязательный
case.create.projectIdstring (uuid) | nullНеобязательный
toAgentIdstring (uuid)Необязательный
phasestringНеобязательный1–120 characters
instructionsstringОбязательный1–20000 characters
expectedHandoffVersionintegerНеобязательный≥ 0
expectedIssueStatusVersionintegerНеобязательный≥ 0
bindIssueIdstring (uuid)Необязательный
initialDocumentsarray<object>Необязательный
initialDocuments[].keyanyОбязательный
initialDocuments[].titlestringОбязательный1–200 characters
initialDocuments[].bodystringОбязательный
workflow_document_textstringНеобязательный1–200000 characterspattern: \S
workflowIdstring (uuid) | nullНеобязательный

Ответы

200SuccessThe request worked; the body holds the result.
202SuccessAccepted; the work continues in the background.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Cases