API Reference

Get All Agent Runs

GET/v1/agent-runs

Authorization

HTTPBearer

Response

200

Successful Response

Body

application/json

data*Data

Request

JavaScriptCurlPython

const response = await fetch('/v1/agent-runs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chat_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "status": "queued",
      "results": [],
      "created_at": "2025-01-18T10:54:40.928Z",
      "updated_at": "2025-01-18T10:54:40.928Z",
      "bundle": "default",
      "toolhouse_id": "default"
    }
  ]
}

Create Agent Run

POST/v1/agent-runs

Authorization

HTTPBearer

Body

application/json

chat_id*Chat Id

bundleBundle

toolhouse_idToolhouse Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agent-runs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chat_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get Agent Run

GET/v1/agent-runs/{run_id}

Authorization

HTTPBearer

Path parameters

run_id*Run Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agent-runs/{run_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Put Agent Run

PUT/v1/agent-runs/{run_id}

Authorization

HTTPBearer

Path parameters

run_id*Run Id

Body

application/json

message*Message

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agent-runs/{run_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}