Skip to main content
PATCH
/
automations
/
{automation_id}
/
sessions
/
{session_id}
/
cancel
Cancel Session
curl --request PATCH \
  --url https://api.example.com/automations/{automation_id}/sessions/{session_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inputs": {},
  "error": "<string>",
  "status": "NEW",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "NEW",
      "prompt": {
        "type": "<string>"
      },
      "result": "<string>",
      "error": "<string>",
      "step": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_type": "START",
        "prompt_template": {
          "type": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "steps_count": 123,
  "current_step": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "NEW",
    "prompt": {
      "type": "<string>"
    },
    "result": "<string>",
    "error": "<string>",
    "step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_type": "START",
      "prompt_template": {
        "type": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Api-key
string | null

Path Parameters

​
automation_id
string<uuid>
required
​
session_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
automation_id
string<uuid>
required
​
inputs
Inputs · object
required
​
error
string | null
required
​
status
enum<string>
required
Available options:
NEW,
RUNNING,
FINISHED,
FAILED
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
steps
AutomationSessionStepRead · object[]
required
​
steps_count
integer
required
​
current_step
AutomationSessionStepRead · object
required