API

Summary

The AndroMate API lets you drive your automations programmatically — from a CI/CD pipeline, a script, or a third‑party integration — without using the web interface.

You authenticate with an API key and call dedicated endpoints under the /job/api/ path. The key identifies its owner, so every call is automatically scoped to your own jobs and devices.

---

Base URL

All API calls target your job backend:

https://<your-job-backend>

Example (dev): https://dev.job.andromate.net

---

Authentication

Every API request must carry your key in the X-API-Key header:

X-API-Key: amk_live_xxxxxxxxxxxxxxxxxxxxxxxx

• No JWT, no X-Role header — the key alone authenticates the request.
• The owner is resolved from the database, never from the request body.

See API Keys to create and manage your keys.

---

Path convention

Prefix	Auth	Usage
/job/api/...	API key (X-API-Key)	programmatic access (this section)
other paths	JWT (web session)	the web/mobile apps

---

Available endpoints

Endpoint	Method	Description
/job/api/jobs/execute	POST	Run a job on one or more devices
/job/api/jobs/executions/{id}	GET	Get the current state of an execution

---

Error format

Every error returns the same JSON shape:

{
  "code": "J-803",
  "message": "API key is expired",
  "status": 403
}

See each endpoint page for the specific error codes.