Wake up an agent

POST/api/agents/{id}/wakeup
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Wake up an agent.

Board failed-run retries supply failedRunId with reason retry_failed_run. Veyra Intelligence derives the exact request and current authorization; a chat retry may return a durable queued/deferred receipt before a run exists. Caller task/comment markers and fresh-session overrides do not authorize replay.

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

Authorization

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. How keys work.

Path parameters

idstringRequiredThe agent's id.

Request body

application/json · required

sourcestringOptionalone of: "timer", "assignment", "on_demand", "automation"
triggerDetailstringOptionalone of: "manual", "ping", "callback", "system"
reasonstring | nullOptional
failedRunIdstring (uuid)Optional
payloadobject | nullOptional
idempotencyKeystring | nullOptional
forceFreshSessionanyRequired
debugobjectOptional
debug.providerTracestringRequiredone of: "raw"

Responses

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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Agents