Create a schedule

POST

agents

{agent_id}

schedules

Create a schedule

curl --request POST \
  --url https://api.axilio.ai/api/v1/agents/{agent_id}/schedules \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "cron_expression": "<string>",
  "time_zone": "<string>",
  "end_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "run_template": {
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "device_class": "phone",
        "capabilities": {
          "accessibility": true
        },
        "phone_id": "<string>",
        "platform": "android"
      }
    ],
    "variables": {}
  },
  "start_at": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "cron_expression": "<string>",
    "time_zone": "<string>",
    "end_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "run_template": {
        "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targets": [
            {
                "device_class": "phone",
                "capabilities": { "accessibility": True },
                "phone_id": "<string>",
                "platform": "android"
            }
        ],
        "variables": {}
    },
    "start_at": "2023-11-07T05:31:56Z"
}
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({
    cron_expression: '<string>',
    time_zone: '<string>',
    end_at: '2023-11-07T05:31:56Z',
    name: '<string>',
    run_template: {
      revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      targets: [
        {
          device_class: 'phone',
          capabilities: {accessibility: true},
          phone_id: '<string>',
          platform: 'android'
        }
      ],
      variables: {}
    },
    start_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.axilio.ai/api/v1/agents/{agent_id}/schedules', 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}/schedules",
  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([
    'cron_expression' => '<string>',
    'time_zone' => '<string>',
    'end_at' => '2023-11-07T05:31:56Z',
    'name' => '<string>',
    'run_template' => [
        'revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'targets' => [
                [
                                'device_class' => 'phone',
                                'capabilities' => [
                                                                'accessibility' => true
                                ],
                                'phone_id' => '<string>',
                                'platform' => 'android'
                ]
        ],
        'variables' => [
                
        ]
    ],
    'start_at' => '2023-11-07T05:31:56Z'
  ]),
  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}/schedules"

	payload := strings.NewReader("{\n  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\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/{agent_id}/schedules")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "cron_expression": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "overlap_policy": "skip",
  "run_template": {
    "network": "restricted",
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "device_class": "phone",
        "capabilities": {
          "accessibility": true
        },
        "ownership": "dedicated",
        "phone_id": "<string>",
        "platform": "android"
      }
    ],
    "variables": {}
  },
  "state": "active",
  "time_zone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "last_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_run_at": "2023-11-07T05:31:56Z",
  "start_at": "2023-11-07T05:31:56Z"
}

{
  "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 creating a schedule of an agent.

cron_expression

string

required

Five-field cron: minute, hour, day of month, month, day of week. For example 0 9 * * 1-5 is 09:00 on weekdays.

Required string length: 1 - 200

time_zone

string

required

The IANA time zone cron_expression is read in, for example America/Los_Angeles or UTC.

Required string length: 1 - 64

end_at

string<date-time>

No occurrence at or after this time. Leave out to run until deleted.

name

string

A label for the schedule.

Maximum string length: 100

overlap_policy

enum<string>

skip (default) drops an occurrence while the previous run is unfinished; queue starts it anyway.

Available options:

skip,

queue

run_template

object

What each run starts with.

Show child attributes

start_at

string<date-time>

No occurrence before this time. Leave out to start now.

Response

Created

A schedule: an agent's recurring runs. Each occurrence of cron_expression, read in time_zone, starts a run with trigger scheduled and this schedule_id.

agent_id

string<uuid>

required

The agent the schedule runs.

created_at

string<date-time>

required

When the schedule was created.

cron_expression

string

required

Five-field cron: minute, hour, day of month, month, day of week.

string<uuid>

required

The schedule's id.

name

string

required

The schedule's label.

overlap_policy

enum<string>

required

skip drops an occurrence while the schedule's previous run is scheduled, queued, running or paused. queue starts it anyway, waiting for a phone like any run.

Available options:

skip,

queue

run_template

object

required

What each run starts with.

Show child attributes

state

enum<string>

required

active runs its occurrences. paused runs none until resumed. ended is final: the schedule passed its end_at.

Available options:

active,

paused,

ended

time_zone

string

required

The IANA time zone cron_expression is read in, so local times hold across daylight saving.

updated_at

string<date-time>

required

When the schedule was last changed.

end_at

string<date-time>

No occurrence at or after this time. Once it passes, the schedule ends and its runs that have not started are cancelled.

last_run_id

string<uuid>

The run the schedule last started.

next_run_at

string<date-time>

When the next occurrence starts a run, or end_at when no occurrence is left before it. Absent unless the schedule is active.

start_at

string<date-time>

No occurrence before this time.

Create a schedule

curl --request POST \
  --url https://api.axilio.ai/api/v1/agents/{agent_id}/schedules \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "cron_expression": "<string>",
  "time_zone": "<string>",
  "end_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "run_template": {
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "device_class": "phone",
        "capabilities": {
          "accessibility": true
        },
        "phone_id": "<string>",
        "platform": "android"
      }
    ],
    "variables": {}
  },
  "start_at": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "cron_expression": "<string>",
    "time_zone": "<string>",
    "end_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "run_template": {
        "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targets": [
            {
                "device_class": "phone",
                "capabilities": { "accessibility": True },
                "phone_id": "<string>",
                "platform": "android"
            }
        ],
        "variables": {}
    },
    "start_at": "2023-11-07T05:31:56Z"
}
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({
    cron_expression: '<string>',
    time_zone: '<string>',
    end_at: '2023-11-07T05:31:56Z',
    name: '<string>',
    run_template: {
      revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      targets: [
        {
          device_class: 'phone',
          capabilities: {accessibility: true},
          phone_id: '<string>',
          platform: 'android'
        }
      ],
      variables: {}
    },
    start_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.axilio.ai/api/v1/agents/{agent_id}/schedules', 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}/schedules",
  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([
    'cron_expression' => '<string>',
    'time_zone' => '<string>',
    'end_at' => '2023-11-07T05:31:56Z',
    'name' => '<string>',
    'run_template' => [
        'revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'targets' => [
                [
                                'device_class' => 'phone',
                                'capabilities' => [
                                                                'accessibility' => true
                                ],
                                'phone_id' => '<string>',
                                'platform' => 'android'
                ]
        ],
        'variables' => [
                
        ]
    ],
    'start_at' => '2023-11-07T05:31:56Z'
  ]),
  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}/schedules"

	payload := strings.NewReader("{\n  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\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/{agent_id}/schedules")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"cron_expression\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"run_template\": {\n    \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"targets\": [\n      {\n        \"device_class\": \"phone\",\n        \"capabilities\": {\n          \"accessibility\": true\n        },\n        \"phone_id\": \"<string>\",\n        \"platform\": \"android\"\n      }\n    ],\n    \"variables\": {}\n  },\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "cron_expression": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "overlap_policy": "skip",
  "run_template": {
    "network": "restricted",
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "device_class": "phone",
        "capabilities": {
          "accessibility": true
        },
        "ownership": "dedicated",
        "phone_id": "<string>",
        "platform": "android"
      }
    ],
    "variables": {}
  },
  "state": "active",
  "time_zone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "last_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_run_at": "2023-11-07T05:31:56Z",
  "start_at": "2023-11-07T05:31:56Z"
}

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

Authorizations

Path Parameters

Body

Response