Update an agent

PATCH

agents

{agent_id}

Update an agent

curl --request PATCH \
  --url https://api.axilio.ai/api/v1/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "accessibility_enabled": true,
  "capture_enabled": true,
  "max_cost_microdollars": 2,
  "max_steps": 250,
  "model": "<string>",
  "name": "<string>",
  "output_schema": {},
  "pause_timeout_seconds": 1830,
  "recording_enabled": true,
  "telemetry_enabled": true,
  "timeout_seconds": 1800
}
'

import requests

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

payload = {
    "accessibility_enabled": True,
    "capture_enabled": True,
    "max_cost_microdollars": 2,
    "max_steps": 250,
    "model": "<string>",
    "name": "<string>",
    "output_schema": {},
    "pause_timeout_seconds": 1830,
    "recording_enabled": True,
    "telemetry_enabled": True,
    "timeout_seconds": 1800
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessibility_enabled: true,
    capture_enabled: true,
    max_cost_microdollars: 2,
    max_steps: 250,
    model: '<string>',
    name: '<string>',
    output_schema: {},
    pause_timeout_seconds: 1830,
    recording_enabled: true,
    telemetry_enabled: true,
    timeout_seconds: 1800
  })
};

fetch('https://api.axilio.ai/api/v1/agents/{agent_id}', 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/{agent_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'accessibility_enabled' => true,
    'capture_enabled' => true,
    'max_cost_microdollars' => 2,
    'max_steps' => 250,
    'model' => '<string>',
    'name' => '<string>',
    'output_schema' => [
        
    ],
    'pause_timeout_seconds' => 1830,
    'recording_enabled' => true,
    '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/{agent_id}"

	payload := strings.NewReader("{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.axilio.ai/api/v1/agents/{agent_id}")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\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).

Path Parameters

agent_id

string<uuid>

required

The agent's id.

Body

application/json

Request body for updating an agent. Omitted fields are left unchanged.

accessibility_enabled

boolean

Use accessibility mode for runs. true needs your organization's access to accessibility mode (a 403 whose message starts with accessibility_unavailable without it).

capture_enabled

boolean

Capture the media runs produce into the file library.

max_cost_microdollars

integer<int64>

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

Required range: x >= 1

max_steps

integer<int64>

Most model steps a run may take.

Required range: 1 <= x <= 500

model

string

The model instruction runs call, one of GET /models.

Minimum string length: 1

name

string

The agent's new name.

Maximum string length: 100

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

output_schema

object | null

The JSON Schema a run's result must satisfy. null clears it, so runs take any result.

Show child attributes

pause_timeout_seconds

integer<int64>

Longest a run waits paused for an answer, in seconds, 60 to 3600.

Required range: 60 <= x <= 3600

recording_enabled

boolean

Record the screen of runs.

telemetry_enabled

boolean

Emit telemetry for runs.

timeout_seconds

integer<int64>

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

Required range: 1 <= x <= 3600

Response

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

Update an agent

curl --request PATCH \
  --url https://api.axilio.ai/api/v1/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "accessibility_enabled": true,
  "capture_enabled": true,
  "max_cost_microdollars": 2,
  "max_steps": 250,
  "model": "<string>",
  "name": "<string>",
  "output_schema": {},
  "pause_timeout_seconds": 1830,
  "recording_enabled": true,
  "telemetry_enabled": true,
  "timeout_seconds": 1800
}
'

import requests

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

payload = {
    "accessibility_enabled": True,
    "capture_enabled": True,
    "max_cost_microdollars": 2,
    "max_steps": 250,
    "model": "<string>",
    "name": "<string>",
    "output_schema": {},
    "pause_timeout_seconds": 1830,
    "recording_enabled": True,
    "telemetry_enabled": True,
    "timeout_seconds": 1800
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessibility_enabled: true,
    capture_enabled: true,
    max_cost_microdollars: 2,
    max_steps: 250,
    model: '<string>',
    name: '<string>',
    output_schema: {},
    pause_timeout_seconds: 1830,
    recording_enabled: true,
    telemetry_enabled: true,
    timeout_seconds: 1800
  })
};

fetch('https://api.axilio.ai/api/v1/agents/{agent_id}', 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/{agent_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'accessibility_enabled' => true,
    'capture_enabled' => true,
    'max_cost_microdollars' => 2,
    'max_steps' => 250,
    'model' => '<string>',
    'name' => '<string>',
    'output_schema' => [
        
    ],
    'pause_timeout_seconds' => 1830,
    'recording_enabled' => true,
    '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/{agent_id}"

	payload := strings.NewReader("{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.axilio.ai/api/v1/agents/{agent_id}")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\n  \"telemetry_enabled\": true,\n  \"timeout_seconds\": 1800\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessibility_enabled\": true,\n  \"capture_enabled\": true,\n  \"max_cost_microdollars\": 2,\n  \"max_steps\": 250,\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {},\n  \"pause_timeout_seconds\": 1830,\n  \"recording_enabled\": true,\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

Update an agent

Authorizations

Path Parameters

Body

Response