API Reference | Toolhouse

Get All Agent Runs

get

/v1/agent-runs

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/agent-runs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chat_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "status": "queued",
      "schedule_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-20T19:04:13.214Z",
      "updated_at": "2025-02-20T19:04:13.214Z",
      "bundle": "default",
      "toolhouse_id": "default",
      "results": [],
      "vars": {}
    }
  ]
}

Successful Response

Create Agent Run

post

/v1/agent-runs

Authorizations

Body

chat_idChat Idrequired

bundleBundle

toolhouse_idToolhouse Id

schedule_idSchedule Id

varsVars

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/agent-runs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"chat_id":"123e4567-e89b-12d3-a456-426614174000","bundle":"default","toolhouse_id":"default","vars":{}}'

200

422

No body

Successful Response

Get Agent Run

get

/v1/agent-runs/{run_id}

Authorizations

Path parameters

run_idRun Idrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/agent-runs/{run_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

No body

Successful Response

Put Agent Run

put

/v1/agent-runs/{run_id}

Authorizations

Path parameters

run_idRun Idrequired

Body

messageMessagerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/agent-runs/{run_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"message":"text"}'

200

422

No body

Successful Response