API Reference - Axilio

The REST reference is generated from Axilio’s public OpenAPI contract. It covers the customer-facing operations available through api.axilio.ai. Each endpoint shows its parameters, request and response schemas, and a Try it panel. Use the Python SDK, Go SDK, or CLI when you want a typed or interactive interface. Use the REST API from another runtime or when you need direct control over HTTP requests.

Base URLs

API	Base URL
REST API	`https://api.axilio.ai/api/v1`
Vision API (Argus)	`https://argus.axilio.ai`

Authentication

Send your API key in the X-Axilio-Api-Key header:

curl https://api.axilio.ai/api/v1/phones/availability \
  -H "X-Axilio-Api-Key: axl_your_key_here"

Get a key from API Keys. See Authentication for the SDK equivalent.

Run the curl examples on Windows

The REST examples use Bash syntax. Git Bash and WSL run them unchanged. To run them in PowerShell:

Call curl.exe, which ships with Windows 10 and 11. In Windows PowerShell 5.1, curl is an alias for Invoke-WebRequest.
Write environment variables as $env:AXILIO_API_KEY.
End a continued line with a backtick (`) instead of \.
Windows PowerShell 5.1 strips the double quotes inside a single-quoted JSON argument. Save the body to a file and pass --data '@body.json', or use PowerShell 7.3 or later, which passes it unchanged.

curl.exe https://api.axilio.ai/api/v1/phones/availability `
  -H "X-Axilio-Api-Key: $env:AXILIO_API_KEY"

REST resources

Resource	What you can do	Reference
Phones and sessions	Check availability, allocate and release phones, inspect sessions, manage phones, and mint live-view or Telemetry stream URLs.	List phones · Check availability
Workflows and runs	Create and revise workflows, start runs immediately, inspect run history and statistics, and cancel runs.	List workflows · List runs
Files	Upload and manage organization library files, deliver a file to a phone, and list files captured during a session.	List files · List session files
Telemetry	Read a session’s Telemetry frames or mint a URL for its live Telemetry stream.	List frames · Mint a stream URL
Usage and billing	Read phone-session and inference usage, account balance, invoices, plan details, and billing preferences. Admins can update auto-recharge and usage-alert settings.	List session usage · Get balance
Organization and API keys	Read organization and member details. Admins can view pending invitations and create, list, or delete API keys.	Get organization · List API keys

Files is the resource name. Upload, download, and delivery are actions on files. Session execution data is exposed through the Telemetry frame contract, not events.

Roles & permissions

Everyone in an organization has one of three roles. The roles are hierarchical, so each role includes the permissions of the roles below it:

Role	Can do
Viewer	Read organization, phone, session, workflow, run, file, Telemetry, usage, and billing resources.
Member	Everything a viewer can do, plus allocate and manage phones, start or cancel runs, edit workflows, and manage or deliver files.
Admin	Everything a member can do, plus manage API keys, view pending invitations, and update auto-recharge or usage-alert settings.

Authenticated operations declare an x-required-role value in the OpenAPI contract. This value is the minimum role, not an exclusive role. viewer allows viewers, members, and admins. member allows members and admins. admin allows admins only. Not sure what you are? Check your role in Settings → Members.

Next steps

SDK quickstart

Allocate and control your first phone with the Python SDK.

Device Control Protocol

Drive an allocated phone over its WebSocket protocol.

Telemetry

Choose a live or retained interface and build a resilient reader.

​Base URLs

​Authentication

​Run the curl examples on Windows

​REST resources

​Roles & permissions

​Next steps

SDK quickstart

Device Control Protocol

Telemetry

Base URLs

Authentication

Run the curl examples on Windows

REST resources

Roles & permissions

Next steps