Skip to main content

API Reference

→ Open the API Playground​

The API Playground is the reference now. All 122 endpoints an API token can reach, grouped by resource, with a request builder, a Run button, and the equivalent code in nine languages.

It is generated from the API service source — permissions.go decides which endpoints a token can reach, main.go supplies the method, and the handler structs supply the schemas — so it cannot drift from the product the way a hand-written list does.

The basics​

The API is at https://api.robomotion.io.

curl -X GET "https://api.robomotion.io/v1/robots.list" \
  -H "Authorization: Bearer $ROBOMOTION_TOKEN"

Create a token in Admin Console → API.

On-Prem and Private Cloud

Your API lives on your own domain under /api — for example https://robomotion.acme.inc/api/v1/robots.list. The playground offers that as a server option.

Two things worth reading first​

  • Authentication — how to send a token, and what you get back when it is missing or wrong.
  • Permissions — which endpoints a read-only token can reach and which need read-write.

Shape of the API​

It is not REST-shaped. Endpoints are verb.noun under a version prefix — /v1/robots.list, /v1/flows.run, /v1/queues.item.insert — so the action is in the path rather than implied by the method. Reads are GET, writes mostly POST, deletes DELETE.

Responses carry ok:

{ "ok": true, "robots": [ ], "total": 4 }

Where the old endpoint pages went​

This section used to list endpoints by hand: 21 of them, with sample responses dated 2020. They are in the playground now, which covers 122 and is generated from source, so the hand-written pages were removed rather than left to drift again. Old links redirect there.