Learn more about the responses that you may receive from the Axiom.ai API.

Understanding the API response

---

After triggering your request, our API will send a response. A successful request will send you a link to view your automation run within the browser, for example:

{
    "OPEN LINK IN BROWSER": "<LINK_TO_RUN_VIEWER>"
}

If the automation has been added to the queue, the response will contain this information, for example:

{
    "status": "queued",
    "message": "Axiom could not start due to a lack of available resources. The task has been queued and will retry in five minutes."
}

If an error has occurred you will find further information on the next steps to take, for example:

{
    "status": "error",
    "message": "Task not found, please check the name and try again."
}

For more information on common errors, see our troubleshooting resources.

Remaining runtime

---

The /remaining-runtime endpoint will return the following payload when successful:

{
    "status": "success",
    "data": [
        "used": 0.47,
        "allowance": 15000,
        "remaining": 14999.53
    ]
}

This will be returned in minutes, the unit that we use to measure your runtime.

List of automations

---

The /list-automations endpoint will return the following payload when successful:

{
    "status": "success",
    "data": {
        "names": [
            "Automation 1",
            "Automation 2",
            ...
        ]
    }
}

Run reports

---

The /run-reports endpoint will return the following payload when successful:

{
    "status": "success",
    "data": {
        "reports": [
            {
                "task_name": "Automation Name",
                "status": "Success",
                "description": "Execution started with Axiom cloud version 4.6.0 (remotely triggered)\n\nAxiom run completed successfully!",
                "created_at": "2025-04-10T15:14:51.000000Z",
                "updated_at": "2025-04-10T15:15:00.000000Z"
            }
        ]
    }
}