API Playground
Every endpoint an API token can reach, with runnable requests and code in nine languages. Get an API token · Authentication · Permissions
Stays in your browser; sent only with requests you run here.
Hire Agent
Provisions a hub agent into the workspace.
read-writePOST/v1/agent.hub.hire
One call creates an application, a bot, a dedicated robot and a running instance, all in a single transaction. Nothing appears in the Designer: the agent's flow lives in the hub repository and the robot fetches it by slug when it runs.
The robot it creates takes an application robot seat, so hiring can fail on the licence even when ordinary robot seats are free.
Hiring the same agent twice is allowed and gives you two independent hires with different application_ids.
Body fields
slug* | string | The agent's catalogue name, as listed on the Agent Hub. |
name | string | Your own label for this hire, for example "Support triage - EU". Defaults to the catalogue name. |
Response
ok | any | Always true on success. A failure returns a non-2xx status with ok: false and an error code. |
hire_id | any | The hire. agent.hub.unhire takes this. |
hub_agent_id | any | The catalogue agent's stable ID, which does not change if the slug is renamed. |
slug | any | Echo of the slug hired. |
application_id | any | Pass this as app_id to run or stop this specific hire. |
instance_id | any | The application instance created for the hire. |
Errors
| 400 | invalid_parameters | slug is missing. |
| 500 | internal_error | — |
| 404 | resource_not_found | No agent with that slug in the hub catalogue. |
| 429 | robot_limit_reached | No application robot seats left on the licence or plan. |
Shapes, parameters and error codes on this page are read from api/agenthub/hire.go in the API service.
curl -X POST "https://api.robomotion.io/v1/agent.hub.hire" \
-H "Authorization: Bearer $ROBOMOTION_TOKEN"Responseexample
{
"ok": true,
"hire_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"hub_agent_id": "9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f",
"slug": "support-triage",
"application_id": "c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
"instance_id": "d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"
}