Skip to main content
POST
/
sessions
/
{session_id}
/
cancel
cURL
curl -X POST 'https://api.gumloop.com/api/v1/sessions/sess_xYz789AbCd/cancel' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
{
  "session": {
    "id": "sess_xYz789AbCd",
    "agent_id": "abc123DEFghiJKL",
    "messages": [],
    "created_at": null,
    "state": "failed",
    "agent_name": null,
    "agent_team_id": null,
    "agent_creator_user_id": null,
    "agent_icon_url": null,
    "agent_tools": [],
    "participants": {},
    "creator": null
  },
  "queue_position": null
}

Authorizations

​
Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Path Parameters

​
session_id
string
required

ID of the session to cancel.

Response

Session state after the cancel attempt. Only id, agent_id, and state are populated on the session envelope.

​
session
object
​
queue_position
integer | null
Example:

null