🏠
Toolhouse
DiscordGithubSign upGo to App
  • 🏠Toolhouse
  • Quick start: deploy your first agent
  • Build agents with the th file
  • Test agents before deploying
  • Deploy and run your agents
  • Agent workers
    • Running Agents asynchronously
      • API Reference
    • Schedule autonomous runs
      • API Reference
  • Toolhouse SDK
    • ✨Quick start (Python)
    • ✨Quick start (TypeScript)
    • Using LlamaIndex
    • Using Vercel AI
  • Choose MCP servers for your agent
  • Customize agents for your end users
  • 💬Execution logs
  • Go to app
Powered by GitBook
On this page
  1. Agent workers
  2. Schedule autonomous runs

API Reference

PreviousSchedule autonomous runsNextToolhouse SDK

Last updated 3 months ago

Text To Cron

get
Authorizations
Query parameters
cronstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /v1/schedules/text-to-cron?cron=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Schedule By Id

get
Authorizations
Path parameters
schedule_idstring · uuidRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Del Schedule

delete
Authorizations
Path parameters
schedule_idstring · uuidRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
delete
DELETE /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

  • GETGet Schedule List
  • POSTCreate Schedule
  • GETText To Cron
  • GETGet Schedule By Id
  • PUTEdit Schedule
  • DELETEDel Schedule

Get Schedule List

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

Successful Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "chat_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-05-12T22:46:08.644Z",
      "updated_at": "2025-05-12T22:46:08.644Z",
      "last_ran_at": "2025-05-12T22:46:08.644Z",
      "active": true,
      "archived": true,
      "cadence": "text",
      "bundle": "text",
      "toolhouse_id": "text",
      "vars": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "title": "text",
      "chat_archived": true,
      "callback_url": "https://example.com"
    }
  ]
}

Create Schedule

post
Authorizations
Body
chat_idstring · uuidRequired
cadencestringRequired
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
422
Validation Error
application/json
post
POST /v1/schedules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

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

No content

Edit Schedule

put
Authorizations
Path parameters
schedule_idstring · uuidRequired
Body
activebooleanOptionalDefault: true
cadencestringRequired
bundleany ofOptionalDefault: default
stringOptional
or
nullOptional
toolhouse_idany ofOptionalDefault: default
stringOptional
or
nullOptional
varsany ofOptional
or
nullOptional
chat_idany ofOptional
string · uuidOptional
or
nullOptional
callback_urlany ofOptional
string · uri · min: 1Optional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
put
PUT /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

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

No content