Sessions

Cancel a session

Ends the run and releases its sandbox. No body is read.

post/o/{org}/sessions/{session}/cancel

Request

  • Base URL: https://api.prix.dev
  • URL: https://api.prix.dev/o/{org}/sessions/{session}/cancel
  • Auth: HTTP bearer

Response

The session as GET reads it, status cancelled, or cancelling while the sandbox is still being released; it reads cancelled from then on.

execution_idstring required

The session id.

org_idstring required

The org as the request's path named it.

project_idstring uuid

The Project the console ran the session in.

status'queued' | 'allocating' | 'running' | 'paused' | 'input_required' | 'needs_review' | 'completed' | 'failed' | 'cancelling' | 'cancelled' | 'expired' required

paused is a resumable session parked between turns; needs_review finished without the proof it was asked for; cancelling appears only in the 202 answer to a cancel whose sandbox is still being released; GET reads cancelled once it is.

harnessstring

claude, codex or opencode.

agent_idstring uuid

The saved agent the session was started from, if any.

modelstring
effortstring
resultstring

The agent's final answer for the last finished turn, in full.

repo_ownerstring
repo_namestring
branchstring
pr_urlstring
input_tokensinteger
output_tokensinteger
cache_read_tokensinteger
cache_write_tokensinteger
total_tokensinteger

Uncached input plus cache writes plus output.

reasoning_tokensinteger
total_cost_usdnumber
tool_calls_countinteger
turns_countinteger
created_atstring date-time
completed_atstring date-time

Changes

No recorded changes to this operation across all 2 revisions of this API.