Cancel a run

POST

runs

{run_id}

:cancel

Cancel a run

curl --request POST \
  --url https://api.axilio.ai/api/v1/runs/{run_id}:cancel \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'POST', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/runs/{run_id}:cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/runs/{run_id}:cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/runs/{run_id}:cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/runs/{run_id}:cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "trigger": "manual",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canceled_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "phone_id": "<string>",
  "run_metadata": {},
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_timeout_seconds": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "success": true,
  "trace_expired_at": "2023-11-07T05:31:56Z",
  "variables": {},
  "video_url": "<string>",
  "workflow_name": "<string>"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Member

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Path Parameters

run_id

string<uuid>

required

run identifier

Response

Full run record returned by run endpoints.

created_at

string<date-time>

required

Timestamp when the run record was created.

string<uuid>

required

Run identifier.

status

enum<string>

required

Current lifecycle state of the run.

Available options:

queued,

running,

completed,

failed,

cancelled

trigger

enum<string>

required

Trigger identifies how the run was initiated.

Available options:

manual,

scheduled,

api

updated_at

string<date-time>

required

Timestamp of the last update to the run record.

user_id

string<uuid>

required

User who initiated the run.

workflow_id

string<uuid>

required

Workflow this run belongs to.

canceled_at

string<date-time>

Timestamp when the run was cancelled.

completed_at

string<date-time>

Timestamp when the run finished.

error_message

string

Error details if the run failed.

phone_id

string

Device executing the run.

run_metadata

object

Arbitrary metadata attached to the run.

Show child attributes

session_id

string<uuid>

Session associated with this run.

start_timeout_seconds

integer<int64>

How long the queued run may wait for a phone before auto-cancel.

started_at

string<date-time>

Timestamp when the run began executing.

success

boolean

Whether the run completed without error.

trace_expired_at

string<date-time>

When the trace recording was deleted.

variables

object

Variable configuration used for the run.

Show child attributes

video_url

string

URL for the run recording video.

workflow_name

string

Display name of the workflow this run belongs to.

Cancel a run

curl --request POST \
  --url https://api.axilio.ai/api/v1/runs/{run_id}:cancel \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'POST', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/runs/{run_id}:cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/runs/{run_id}:cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/runs/{run_id}:cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/runs/{run_id}:cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "trigger": "manual",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canceled_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "phone_id": "<string>",
  "run_metadata": {},
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_timeout_seconds": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "success": true,
  "trace_expired_at": "2023-11-07T05:31:56Z",
  "variables": {},
  "video_url": "<string>",
  "workflow_name": "<string>"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Vision API

Authorizations

Path Parameters

Response