Skip to content
Olivares AI docs

Cancels the active provider turn of a live session and keeps its owned process running; it is the non-terminal control, /stop remains the terminal one, and the optional body decides which control plane answers — absent, it is the legacy interrupt of a non-work run; with a positive work_lease_fence, it is the fenced control this work-bound run's input and stop already use.

POST
/v1/m/sessions/runs/{ref}/interrupt
 
curl --request POST \
  --url https://example.com/v1/m/sessions/runs/example/interrupt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "work_lease_fence": 1 }'

Cancels the active provider turn of a live session and keeps its owned process running; it is the non-terminal control, /stop remains the terminal one, and the optional body decides which control plane answers — absent, it is the legacy interrupt of a non-work run; with a positive work_lease_fence, it is the fenced control this work-bound run’s input and stop already use.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
ref
required
string

Path parameter ref.

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body

Section titled “ Request Body ”
Media type application/json

Optional fenced turn interruption. An empty body preserves legacy non-work run behavior; a positive work_lease_fence selects the same fenced WorkItem control plane this run’s input and stop use. It cancels the active provider turn only: the owned process, its conversation and the run stay usable for the next input, and it never falls back to stop.

object
work_lease_fence
integer format: int64
>= 1
Example generated 
{
  "work_lease_fence": 1
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The run resource after the control was applied

Media type application/json
object
run_ref
required

The operated session’s stable reference.

string
state
required

The run’s derived lifecycle state after the control.

string
key
additional properties
any
Example generated 
{
  "run_ref": "example",
  "state": "example"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
Example generated 
{}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
Example generated 
{}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
Example generated 
{}

404

Section titled “ 404 ”

Not found

Media type application/json
object
Example generated 
{}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
Example generated 
{}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
Example generated 
{}

503

Section titled “ 503 ”

The outcome is UNKNOWN: required authority, evidence or store could not be observed, and any external effect may or may not have crossed

Media type application/json
object
code
required

The durable outcome name, e.g. work_input_ambiguous or evidence_unavailable.

string
error
required
object
code
required
string
message
required
string
key
additional properties
any
evidence_ref

Present when the refusal names the field or evidence it could not resolve.

string
verdict
required

The uncertain verdict: the outcome could not be observed.

string
Allowed values: NO_HE_PODIDO_MIRAR
key
additional properties
any
Example 
{
  "verdict": "NO_HE_PODIDO_MIRAR"
}