Skip to main content

Run an official bot template (create a task) — POST /v3/bots/templates/{template_id}/runs

Starts a new task execution from an official Bot template and returns a `task_id`. Use `GET /v3/bots/templates` to discover templates and `GET /v3/bots/templates/{template_id}` to inspect the template `input_schema`. Provide an `input` object that confo

Written by Maggie

POST /v3/bots/templates/{template_id}/runs

Starts a new task execution from an official Bot template and returns a `task_id`.Use `GET /v3/bots/templates` to discover templates and `GET /v3/bots/templates/{template_id}` to inspect the template `input_schema`.Provide an `input` object that conforms to the schema. Optionally select a `proxy_region` returned by `GET /v3/bots/regions`, and configure completion or status-change callbacks.Template runs do not support the MCP execution context.

Authentication

HTTPBearer

Parameters

  • template_id (path, string, required) — Public Bot template identifier.

Request body

{  "input": {},  "proxy_region": "US",  "callback_url": "string",  "status_change_callback_url": "string"}

Responses

200 — Template run created.

{  "task_id": "string",  "status": "created"}

400 — Bot template not found. Returns error code 10176.

{  "code": 123,  "msg": "Invalid task_id",  "data": null,  "ts": 1786634400000,  "time": "2026-08-13 18:00:00",  "traceId": "a1b2c3d4e5f6"}

500 — Internal Server Error

{  "code": 123,  "msg": "Invalid task_id",  "data": null,  "ts": 1786634400000,  "time": "2026-08-13 18:00:00",  "traceId": "a1b2c3d4e5f6"}

Did this answer your question?