API Reference

Get Schedule List

GET/v1/schedules

Authorization

HTTPBearer

Response

200

Successful Response

Body

application/json

data*Data

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "chat_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-05T10:50:42.196Z",
      "updated_at": "2025-02-05T10:50:42.196Z",
      "last_ran_at": "2025-02-05T10:50:42.196Z",
      "active": true,
      "archived": false,
      "cadence": "text",
      "bundle": "default",
      "toolhouse_id": "default",
      "title": "text"
    }
  ]
}

Create Schedule

POST/v1/schedules

Authorization

HTTPBearer

Body

application/json

chat_id*Chat Id

cadence*Cadence

bundleBundle

toolhouse_idToolhouse Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

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

Response

422

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

Text To Cron

GET/v1/schedules/text-to-cron

Authorization

HTTPBearer

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

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

Response

422

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

Get Schedule By Id

GET/v1/schedules/{schedule_id}

Authorization

HTTPBearer

Path parameters

schedule_id*Schedule Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

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

Response

422

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

Edit Schedule

PUT/v1/schedules/{schedule_id}

Authorization

HTTPBearer

Path parameters

schedule_id*Schedule Id

Body

application/json

activeActive

cadence*Cadence

bundleBundle

stringnull

toolhouse_idToolhouse Id

stringnull

chat_idChat Id

string (uuid)null

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/schedules/{schedule_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": true,
      "cadence": "text",
      "bundle": "default",
      "toolhouse_id": "default"
    }),
});
const data = await response.json();

Response

422

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

Del Schedule

DELETE/v1/schedules/{schedule_id}

Authorization

HTTPBearer

Path parameters

schedule_id*Schedule Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/schedules/{schedule_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

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