API Reference

Get Schedule List

get

Authorizations

Responses

200

Successful Response

application/json

get

HTTPcURLJavaScriptPython

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-24T15:08:03.545Z",
      "updated_at": "2025-05-24T15:08:03.545Z",
      "last_ran_at": "2025-05-24T15:08:03.545Z",
      "active": true,
      "archived": false,
      "cadence": "text",
      "bundle": "default",
      "toolhouse_id": "default",
      "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

HTTPcURLJavaScriptPython

POST /v1/schedules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

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

No content

Text To Cron

get

Authorizations

Query parameters

cronstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

GET /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

HTTPcURLJavaScriptPython

PUT /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

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

No content

Del Schedule

delete

Authorizations

Path parameters

schedule_idstring · uuidRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content