Endpoints
A single-page lookup of every axiom.ai API endpoint. For full request and response details, follow the link in the rightmost column.
REST endpoints
The base URL for all REST endpoints is https://lar.axiom.ai/api/v3. All requests are POST with a JSON body. Authentication is by API key in the key field of the body, see Authentication.
| Method | Path | Required body fields | Optional | Reference |
|---|---|---|---|---|
POST | /trigger | key, name | data | Trigger an automation |
POST | /list-automations | key | List automations | |
POST | /run-reports | key | count | List run reports |
POST | /run-data | key, name | Check run status | |
POST | /stop | pid, pw | Stop a run | |
POST | /remaining-runtime | key | Check remaining runtime |
CDP endpoint
For driving a cloud browser from your code, connect a Chrome DevTools Protocol client to the WebSocket endpoint below. The API key is passed as the token query parameter.
| Protocol | Endpoint | Reference |
|---|---|---|
wss | wss://cdp-lb.axiom.ai/?token=YOUR_API_KEY | Start a session |
Versioning
The API version is part of the path. The current version is v3. Older versions are deprecated and not maintained, always use v3 in new integrations.
When a future major version ships, both the new and old paths will be served in parallel for a transition period. Breaking changes within a version are avoided wherever possible.
Transport and headers
- All requests use HTTPS, plain HTTP is not supported.
- The
Content-Typeheader must beapplication/json. - No other custom headers are required. Specifically, the API key does not go in an
Authorizationheader, it goes in the JSON body. - All responses are JSON.