Skip to main content
GET
Get Goal Bot
Goal bots and task agents are the same object. The two engines merged; /api/goal-bots and /api/tasks are aliases over one collection and return identical bodies. Every response carries both goalBot and taskAgent (or goalBots and taskAgents) so integrations written against either name keep working.The older stage-based engine moved to /api/instructions and is being retired.
Reads one bot by id. The lookup is scoped to your workspace, so an id from another workspace returns 404 rather than leaking anything.

Authentication

Pass your workspace API key as a Bearer token, or use a Clerk session token.

Path parameter

string
required
The bot id — _id from GET /api/goal-bots or goalBot._id from create. A malformed id returns 400 Invalid id.

Example

Success (200 OK)

Response

object
The bot.
object
The same object under the pre-rename key.

Errors