Endpoints
A single-page lookup of every axiom.ai API endpoint. For full request and response details, follow the link in the rightmost column.
The base URL for all REST endpoints is https://lar.axiom.ai. All requests are POST with a JSON body, except where noted. Authentication for auth: api-key rows can be passed in any of three transports — the X-API-KEY header, Authorization: Bearer, or the key field in the body. See Authentication.
Step API (v5)
The Step API drives a cloud browser session step by step. These endpoints are what the @axiom_ai/api Node library wraps. The library is the recommended way to call them; the table below is the raw shape.
| Method | Path | Auth | Required body | Reference |
|---|---|---|---|---|
POST | /api/v5/browser/open | api-key | — | Start a session |
POST | /api/v5/browser/close | api-key | cdpLink | Close a session |
POST | /api/v5/step | api-key | cdpLink, step, step-specific fields | Step API overview |
POST | /api/v5/step/result | api-key | cdpLink, stepId | Internal — the library polls this when a step's HTTP call times out before the pod returns the step result. |
Orchestrate API (v3)
The Orchestrate API triggers automations authored in the No-Code Tool or Code Dashboard, lists them, and reports on their runs.
| Method | Path | Auth | Required body | Optional | Reference |
|---|---|---|---|---|---|
POST | /api/v3/trigger | body-key only | key, name | data | Trigger an automation |
POST | /api/v3/stop | pid + pw (no key) | pid, pw | Stop a run | |
POST | /api/v3/list-automations | api-key | — | List automations | |
POST | /api/v3/run-reports | api-key | — | count | List run reports |
POST | /api/v3/run-data | api-key | name | Check run status | |
POST | /api/v3/remaining-runtime | api-key | — | Check remaining runtime | |
POST | /api/v3/axiom-names | api-key | — | List automation names (alias). |
Note: POST /api/v3/trigger is the legacy trigger endpoint and reads the key directly from the body — X-API-KEY and Bearer are not accepted there. Every other auth: api-key row above accepts all three transports.
CDP endpoint
For driving a cloud browser from your code directly over Chrome DevTools Protocol, connect a CDP-speaking client to the WebSocket below. The API key is passed as the token query parameter.
| Protocol | Endpoint | Reference |
|---|---|---|
wss | wss://cdp-lb.axiom.ai/?token=YOUR_API_KEY | Chrome API |
Versioning
The API version is part of the path. There are two active surfaces:
- v5 — the Step API (
/api/v5/browser/*,/api/v5/step). Use this for code-driven, step-by-step browser sessions. - v3 — the Orchestrate API (
/api/v3/trigger,/api/v3/run-data, etc.). Use this to fire and inspect saved automations.
Both are current and maintained. Pick by what you're doing, not by version number. When a future major version ships, both the new and old paths will be served in parallel for a transition period.
Transport and headers
- All requests use HTTPS; plain HTTP is not supported.
- The
Content-Typeheader must beapplication/json. - Authentication carriers (any one of these works for
auth: api-keyendpoints):X-API-KEY: <key>header,Authorization: Bearer <key>header, orkeyfield in the JSON body. See Authentication for examples. - All responses are JSON.