API Reference

The Bearer Token is the TOOLHOUSE_API_KEY. You can find your API key(s) here.

Get All Agent Runs

get
Authorizations
Responses
200
Successful Response
application/json
get
GET /v1/agent-runs HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chat_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "schedule_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "queued",
      "results": [
        {}
      ],
      "created_at": "2025-06-21T04:36:52.396Z",
      "updated_at": "2025-06-21T04:36:52.396Z",
      "bundle": "default",
      "toolhouse_id": "default",
      "vars": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "callback_url": "https://example.com",
      "mcp_servers": [
        "text"
      ]
    }
  ]
}

Create Agent Run

post
Authorizations
Body
chat_idstring · uuidRequired
schedule_idany ofOptional
string · uuidOptional
or
nullOptional
bundlestringOptionalDefault: default
toolhouse_idstringOptionalDefault: default
varsany ofOptional
or
nullOptional
callback_urlany ofOptional
string · uri · min: 1Optional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
post
POST /v1/agent-runs HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "chat_id": "123e4567-e89b-12d3-a456-426614174000",
  "schedule_id": "123e4567-e89b-12d3-a456-426614174000",
  "bundle": "default",
  "toolhouse_id": "default",
  "vars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "callback_url": "https://example.com"
}

No content

Get Agent Run

get
Authorizations
Path parameters
run_idstring · uuidRequired
Responses
200
Successful Response
application/json
get
GET /v1/agent-runs/{run_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "chat_id": "123e4567-e89b-12d3-a456-426614174000",
    "schedule_id": "123e4567-e89b-12d3-a456-426614174000",
    "results": [
      {}
    ],
    "status": "queued",
    "created_at": "2025-06-21T04:36:52.396Z",
    "updated_at": "2025-06-21T04:36:52.396Z",
    "bundle": "default",
    "toolhouse_id": "default",
    "vars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "callback_url": "https://example.com",
    "last_agent_message": "text"
  }
}

Put Agent Run

put
Authorizations
Path parameters
run_idstring · uuidRequired
Body
messagestringRequired
Responses
200
Successful Response
application/json
Responseany
put
PUT /v1/agent-runs/{run_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}

No content

Last updated