FruxonDocs
ApiFruxon channel

Stops the turn in flight on a sandbox session.

Cancels every run still going on the session's conversation: a run parked on an approval or a consult ends now, a running one ends at its worker's next checkpoint (its terminal frame then arrives on the stream). Returns how many runs that was; zero means the turn had already finished. Only the person who opened the session may do this (403 otherwise), since it needs no admin role on the agent. Runs started by a trigger fire on the session are not covered.

POST
/v1/tenants/{tenant}/fruxon/sessions/{session}:cancelTurn

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

session*string

The sandbox session whose turn to stop.

tenant*string

The tenant identifier

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/fruxon/sessions/string:cancelTurn"
{
  "cancelledRuns": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}