API Reference
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-06-25T01:57:37.422Z",
"updated_at": "2025-06-25T01:57:37.422Z",
"last_ran_at": "2025-06-25T01:57:37.422Z",
"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"
}
]
}
Authorizations
Body
chat_idstring · uuidRequired
cadencestringRequired
bundlestringOptionalDefault:
default
toolhouse_idstringOptionalDefault:
default
varsany ofOptional
or
nullOptional
callback_urlany ofOptional
string · uri · min: 1Optional
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: 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
Authorizations
Path parameters
schedule_idstring · uuidRequired
Body
activebooleanOptionalDefault:
true
cadencestringRequired
bundleany ofOptionalDefault:
default
stringOptional
nullOptional
toolhouse_idany ofOptionalDefault:
default
stringOptional
nullOptional
varsany ofOptional
or
nullOptional
chat_idany ofOptional
string · uuidOptional
nullOptional
callback_urlany ofOptional
string · uri · min: 1Optional
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: 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
Last updated