Trigger a desktop run

The /desktop-trigger endpoint queues a run of a saved No-Code Tool automation on your desktop app, instead of on axiom.ai's cloud infrastructure. Use it when the automation needs to run on your own machine — for example because it depends on local files, a locally-installed app, or a network only your computer can reach.

Requirements

A Pro tier subscription or above.
The automation must have Route webhook triggers to desktop turned on. See Run via API on desktop for how to enable it.
The axiom.ai desktop app must be installed, running, and logged into the same account.

Request

POST /api/v5/desktop-trigger

Parameter	Type	Required	Description
`key`	string	Yes	Your API key. See Authentication.
`taskName`	string	Yes	Exact name of the automation, as it appears in the Dashboard. Case-sensitive and whitespace-sensitive.

Response

Success: run queued

{
  "queued": true
}

A 202 response means the run has been queued for your desktop app to pick up — it doesn't mean the run has started. If the desktop app isn't running when the request comes in, the run starts as soon as it's next online, as long as that happens within 24 hours. After 24 hours an unclaimed trigger expires and is dropped.

Error: request rejected

{
  "status": "error",
  "message": "Unable to authenticate, please check your API key and try again."
}

Field	Type	Description
`status`	string	`error` when the call failed.
`message`	string	Description of what went wrong. See Errors below.

Example

curl -X POST https://lar.axiom.ai/api/v5/desktop-trigger \
  -H "Content-Type: application/json" \
  -d '{
    "key": "your-api-key-here",
    "taskName": "My First Automation"
  }'

Errors

Response	Cause
`Unable to authenticate, you must send an API key.`	`key` is missing from the request body.
`Missing task name, you must send the name of the task that you wish to trigger.`	`taskName` is missing from the request body.
`Unable to authenticate, please check your API key and try again.`	`key` doesn't match an active API key. Generate a new one in the Dashboard.
`Your account has been locked due to too many failed login attempts, please contact support to unlock it.`	Too many failed login attempts on the account. Contact support.
`You must have a pro subscription or higher to use this API.`	The account is below the Pro tier.
`Desktop webhook not enabled for this task`	The automation exists, but Route webhook triggers to desktop hasn't been turned on for it. See Run via API on desktop.
404, `taskName` not found	The `taskName` doesn't match any automation in your account. Almost always a case or whitespace mismatch — copy the name directly from the Dashboard.

Notes

Authentication is body-only: send key in the JSON body. The X-API-KEY and Authorization: Bearer headers accepted elsewhere in the API are not supported on this endpoint.
Input data (the data array supported by Trigger an automation) isn't supported on desktop-triggered runs.
There's currently no endpoint to check the status of a desktop-triggered run from outside the desktop app — check the run's history in the Dashboard, or in the desktop app itself.

Webhooks from a step