Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:dav_ak_live_your_token
required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Path Parameters

projectId
string
required

Project id. May be compound in the form {projectId}--{branchName}.

Minimum string length: 1
sessionId
string<uuid>
required

Session id from createSession.

Response

The run was halted, or there was none to halt.

sessionId
string<uuid>
required
taskId
string
required
stopped
boolean
required

False when there was no run to stop, which is not a failure — you asked for a state you already had.

status
enum<string>
required
  • no_session — the machine has no record of this session; it lapsed or the project restarted. Create a new one.
  • project_not_running — the session is known but its project has unloaded.
  • idle — the session is live and no run has been started.
  • starting — a run is being set up.
  • running — a run is in progress.
  • paused — a run was stopped and can be continued with a new prompt.
  • completed — the run finished.
  • failed — the run ended in an error. The transcript says why.
  • unknown — the machine could not be reached for this field. Retry; anything else in the same response is still valid.

paused, completed, and failed are terminal for a run.

Available options:
no_session,
project_not_running,
idle,
starting,
running,
paused,
completed,
failed,
unknown