La referencia de la API se publica en inglés.
Start or hand off a case using its primary task
/api/companies/{companyId}/case-handoffsStart 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.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
Cuerpo de la solicitud
application/json · obligatorio
1–240 characters1–120 characters1–500 charactersat most 8000 characters1–120 characters1–20000 characters≥ 0≥ 01–200 characters1–200000 characterspattern: \SRespuestas
details names each field that failed.Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.