Agents

Create an agent

Creates an agent: a task for a phone, as instructions an agent works through a model or as code, with the model, output schema and limits its runs use. Sending instructions or code creates the agent’s first revision with it; sending source_run_id saves one of your agent runs as the agent, its task or its script as the first revision. A name already used in the organization is 409; an unsupported model, an invalid output schema, both instructions and code, or a run with no task or script to save is 400; another organization’s run is 404.

POST

agents

Create an agent

curl --request POST \
  --url https://api.axilio.ai/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "accessibility_enabled": true,
  "capture_enabled": true,
  "code": "<string>",
  "instructions": "<string>",
  "max_cost_microdollars": 2,
  "max_steps": 250,
  "model": "<string>",
  "output_schema": {},
  "pause_timeout_seconds": 1830,
  "recording_enabled": true,
  "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "telemetry_enabled": true,
  "timeout_seconds": 1800
}
'

import requests

url = "https://api.axilio.ai/api/v1/agents"

payload = {
    "name": "<string>",
    "accessibility_enabled": True,
    "capture_enabled": True,
    "code": "<string>",
    "instructions": "<string>",
    "max_cost_microdollars": 2,
    "max_steps": 250,
    "model": "<string>",
    "output_schema": {},
    "pause_timeout_seconds": 1830,
    "recording_enabled": True,
    "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "telemetry_enabled": True,
    "timeout_seconds": 1800
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    accessibility_enabled: true,
    capture_enabled: true,
    code: '<string>',
    instructions: '<string>',
    max_cost_microdollars: 2,
    max_steps: 250,
    model: '<string>',
    output_schema: {},
    pause_timeout_seconds: 1830,
    recording_enabled: true,
    source_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    telemetry_enabled: true,
    timeout_seconds: 1800
  })
};

fetch('https://api.axilio.ai/api/v1/agents', 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/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'accessibility_enabled' => true,
    'capture_enabled' => true,
    'code' => '<string>',
    'instructions' => '<string>',
    'max_cost_microdollars' => 2,
    'max_steps' => 250,
    'model' => '<string>',
    'output_schema' => [
        
    ],
    'pause_timeout_seconds' => 1830,
    'recording_enabled' => true,
    'source_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'telemetry_enabled' => true,
    'timeout_seconds' => 1800
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/agents"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")

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

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.axilio.ai/api/v1/agents")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/agents")

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>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}"

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

{
  "accessibility_enabled": true,
  "capture_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_cost_microdollars": 123,
  "max_steps": 123,
  "model": "<string>",
  "name": "<string>",
  "pause_timeout_seconds": 123,
  "recording_enabled": true,
  "telemetry_enabled": true,
  "timeout_seconds": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "current_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_run_at": "2023-11-07T05:31:56Z",
  "output_schema": {}
}

{
  "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"
}

{
  "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).

Body

application/json

Request body for creating an agent. With instructions, code or source_run_id, the agent's first revision is created with it.

name

string

required

The agent's name: letters, numbers, hyphens and underscores, unique within the organization.

Maximum string length: 100

Pattern: ^[A-Za-z0-9_-]+$

accessibility_enabled

boolean

Use accessibility mode for runs (default false). Needs your organization's access to accessibility mode: without it the create is refused with a 403 whose message starts with accessibility_unavailable.

capture_enabled

boolean

Capture the media runs produce into the file library (default true).

code

string

Python the agent runs. Creates a code revision. Leave out to add a revision later, or send instructions instead.

from

enum<string>

With source_run_id, what the first revision is. task (default): the run's task, as an instructions revision. script: the script the run left (GET /runs/{run_id}/script), as a code revision. A run with no task, or no script, is 400.

Available options:

task,

script

instructions

string

The task for the agent to work through a model. Creates an instructions revision. Leave out to add a revision later, or send code instead.

Maximum string length: 20000

max_cost_microdollars

integer<int64>

Most a run's model steps may cost, in microdollars (default 10000000).

Required range: x >= 1

max_steps

integer<int64>

Most model steps a run may take (default 500).

Required range: 1 <= x <= 500

model

string

The model instruction runs call, one of GET /models. Defaults to the platform default.

on_failure

enum<string>

With code: what a run does when a step fails. fail (default) fails the run. ask pauses the run for a person (reason step_check_failed), who retries the step or completes the run with its output. repair hands the run to the agent, which finishes the task from the live screen and proposes a fixed revision for a person to promote.

Available options:

fail,

ask,

repair

output_schema

object

The JSON Schema a run's result must satisfy. Leave out to take any result.

Show child attributes

pause_timeout_seconds

integer<int64>

Longest a run waits paused for an answer, in seconds (default 600, 60 to 3600).

Required range: 60 <= x <= 3600

recording_enabled

boolean

Record the screen of runs (default false).

source_run_id

string<uuid>

Save one of your agent runs as the agent: its first revision comes from the run (see from), and the run's model, output schema and limits stand in for any left out here. Send it without instructions or code. Another organization's run is 404.

telemetry_enabled

boolean

Emit telemetry for runs (default true).

timeout_seconds

integer<int64>

Longest a run may take, in seconds (default 3600, at most 3600).

Required range: 1 <= x <= 3600

Response

Created

An agent: a task for a phone, as instructions the agent works through a model or as code, with the settings its runs use.

accessibility_enabled

boolean

required

Runs use accessibility mode, which needs a phone that supports it.

capture_enabled

boolean

required

Runs capture the media they produce on the phone into the file library.

created_at

string<date-time>

required

When the agent was created.

string<uuid>

required

The agent's id.

max_cost_microdollars

integer<int64>

required

Most a run's model steps may cost, in microdollars.

max_steps

integer<int64>

required

Most model steps a run may take.

model

string

required

The model an instructions revision's runs call, one of GET /models.

name

string

required

The agent's name, unique within the organization.

pause_timeout_seconds

integer<int64>

required

Longest a run waits paused for an answer, in seconds, before it fails with input_timeout. A pause also ends with the session.

recording_enabled

boolean

required

Runs record the screen.

telemetry_enabled

boolean

required

Runs emit telemetry, live and stored.

timeout_seconds

integer<int64>

required

Longest a run may take, in seconds, within the one-hour session cap.

updated_at

string<date-time>

required

When the agent was last changed.

current_revision_id

string<uuid>

The revision runs of the agent use. Absent until the agent has one.

last_run_at

string<date-time>

When a run of the agent last started.

output_schema

object

The JSON Schema a run's result must satisfy. Absent takes any result.

Show child attributes

Create an agent

curl --request POST \
  --url https://api.axilio.ai/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "accessibility_enabled": true,
  "capture_enabled": true,
  "code": "<string>",
  "instructions": "<string>",
  "max_cost_microdollars": 2,
  "max_steps": 250,
  "model": "<string>",
  "output_schema": {},
  "pause_timeout_seconds": 1830,
  "recording_enabled": true,
  "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "telemetry_enabled": true,
  "timeout_seconds": 1800
}
'

import requests

url = "https://api.axilio.ai/api/v1/agents"

payload = {
    "name": "<string>",
    "accessibility_enabled": True,
    "capture_enabled": True,
    "code": "<string>",
    "instructions": "<string>",
    "max_cost_microdollars": 2,
    "max_steps": 250,
    "model": "<string>",
    "output_schema": {},
    "pause_timeout_seconds": 1830,
    "recording_enabled": True,
    "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "telemetry_enabled": True,
    "timeout_seconds": 1800
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    accessibility_enabled: true,
    capture_enabled: true,
    code: '<string>',
    instructions: '<string>',
    max_cost_microdollars: 2,
    max_steps: 250,
    model: '<string>',
    output_schema: {},
    pause_timeout_seconds: 1830,
    recording_enabled: true,
    source_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    telemetry_enabled: true,
    timeout_seconds: 1800
  })
};

fetch('https://api.axilio.ai/api/v1/agents', 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/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'accessibility_enabled' => true,
    'capture_enabled' => true,
    'code' => '<string>',
    'instructions' => '<string>',
    'max_cost_microdollars' => 2,
    'max_steps' => 250,
    'model' => '<string>',
    'output_schema' => [
        
    ],
    'pause_timeout_seconds' => 1830,
    'recording_enabled' => true,
    'source_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'telemetry_enabled' => true,
    'timeout_seconds' => 1800
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/agents"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")

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

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.axilio.ai/api/v1/agents")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/agents")

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>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"code\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"source_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}"

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

{
  "accessibility_enabled": true,
  "capture_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_cost_microdollars": 123,
  "max_steps": 123,
  "model": "<string>",
  "name": "<string>",
  "pause_timeout_seconds": 123,
  "recording_enabled": true,
  "telemetry_enabled": true,
  "timeout_seconds": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "current_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_run_at": "2023-11-07T05:31:56Z",
  "output_schema": {}
}

{
  "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"
}

{
  "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

Argus API

Create an agent

Authorizations

Body

Response