Authentication

Axilio authenticates SDK and REST requests with an API key. The CLI can use an API key or a browser sign-in.

Create an API key

Open API Keys for your organization. The organization-specific page is /dashboard/<organization-slug>/api-keys. Choose Create API Key, give the key a name, and copy the secret. Keys start with axl_.

Axilio shows the secret only when you create the key. Store it in a secret manager. Never commit it, paste it into logs, or pass it as a command-line argument that your shell may record.

Authenticate an interface

CLI
Python SDK
Go SDK
REST API

For interactive use, sign in through your browser and verify the session:

axilio login
axilio status

For non-interactive use, expose an API key through the environment:

export AXILIO_API_KEY=axl_your_key_here
axilio status

$env:AXILIO_API_KEY = "axl_your_key_here"
axilio status

A browser session can switch organizations with axilio orgs use <organization-slug>. An API key remains scoped to the organization that created it.

Set the environment variable before starting your process:

export AXILIO_API_KEY=axl_your_key_here

$env:AXILIO_API_KEY = "axl_your_key_here"

Client reads it automatically:

from axilio.platform import Client

client = Client()

You can also pass api_key= from a secret provider:

client = Client(api_key=secret_value)

Read the secret from your environment or secret provider and pass it to the generated client:

import (
    "os"

    client "github.com/axilioai/platform-go/client"
    option "github.com/axilioai/platform-go/option"
)

c := client.NewClient(
    option.WithAPIKey(os.Getenv("AXILIO_API_KEY")),
)

REST API References:

List the organization’s files: GET /files

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

curl --silent --show-error --fail-with-body \
  --url https://api.axilio.ai/api/v1/files \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY"

curl.exe --silent --show-error --fail-with-body `
  --url https://api.axilio.ai/api/v1/files `
  --header "X-Axilio-Api-Key: $env:AXILIO_API_KEY"

The other REST examples in these docs use Bash syntax. See Run the curl examples on Windows.Do not send the key to presigned file upload or download URLs. Those URLs authorize the storage request themselves and expire after a short time.

Python client options

Setting	Default	What it does
`api_key`	`AXILIO_API_KEY`	Authenticates requests. Required.
`base_url`	`AXILIO_BASE_URL`, then `https://api.axilio.ai`	Selects the API host.
`timeout`	`30.0`	Sets the per-request timeout in seconds.
`max_retries`	`3`	Retries temporary failures before returning an error.

Each API key belongs to one organization. Create a separate key for each organization that your application needs to access.

Next steps

SDK quickstart

Allocate and inspect your first phone with Python.

Get Started

Phones and Sessions

Workflows and Runs

Files

Observability

Telemetry

Usage

Billing

Organization

Reference

Authentication

Create an API key

Authenticate an interface

Python client options

Next steps

SDK quickstart

CLI

​Create an API key

​Authenticate an interface

​Python client options

​Next steps

SDK quickstart

CLI

Create an API key

Authenticate an interface

Python client options

Next steps