Skip to main content

Retrieve a bot — GET /v3/bots/{bot_id}

Fetches a Bot definition, including its creation time and published schemas. For an unpublished Bot owned by the current company, `published_at`, `input_schema`, and `output_schema` are null; attempting to run it returns error code `10020`. If you only ne

Written by Maggie

GET /v3/bots/{bot_id}

Fetches a Bot definition, including its creation time and published schemas. For an unpublished Bot owned by the current company, `published_at`, `input_schema`, and `output_schema` are null; attempting to run it returns error code `10020`. If you only need a list of runnable Bots, use `GET /v3/bots`.

Authentication

HTTPBearer

Parameters

  • bot_id (path, string, required) — Public bot identifier.

Responses

200 — Bot returned.

{  "bot_id": "string",  "bot_type": "workflow",  "name": "string",  "description": "string",  "created_at": "2026-01-01T00:00:00Z",  "published_at": "2026-01-01T00:00:00Z",  "input_schema": {},  "output_schema": {}}

400 — Bot not found. Returns error code 10111.

{  "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?