Sessions

Interrupt a session turn

post/api/v1/sessions/{id}/turns/{turnId}/interrupt

Response

Interrupt requested

seqinteger required

Assigned event sequence number.

idstring required
tsstring date-time required
run_idstring required
node_idstring nullable
node_labelstring nullable
stage_idstring nullable

Stage execution identity, formatted as "{node_id}@{visit}".

parallel_group_idstring nullable

Durable identity of one execution of a parallel node, formatted as "{node_id}@{visit}".

parallel_branch_idstring

Durable identity of one branch within a parallel execution, in {parallel_group_id}:{index} form.

session_idstring nullable
parent_session_idstring nullable
tool_call_idstring nullable

Stable identifier for a tool call, present on agent.tool.* events and other durable events that directly describe the same tool call.

eventstring required

Event type discriminator.

propertiesobject

Example response

{
  "seq": 42,
  "parallel_branch_id": "review_fork@3:1",
  "event": "stage.started"
}

Changes

Changed in 4 of the 138 revisions of this API.63

    • added subschema #2 to the //// response property oneOf list for the response status

      response-property-one-of-added

    • the //// response's property type changed from string null to no type for status

      response-property-type-changed

  • 3c01c6d3d31e21See the full diff
    • the response property //// became nullable for the status

      response-property-became-nullable

    • the //// response's property type changed from no type to string null for status

      response-property-type-changed

    • removed subschema #2 from the //// response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added subschema #2 to the //// response property oneOf list for the response status

      response-property-one-of-added

    • the //// response's property type changed from string null to no type for status

      response-property-type-changed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed anonymous discriminator mapping keys from the //////// response property for the response status

      response-property-discriminator-mapping-deleted

    • removed from the //////// response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog