AlterLabAPI Reference
Auto-generated
Schedules
API reference for schedules endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.POST /api/v1/schedules
POST
/api/v1/schedulesCreate a schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Name |
| urls | string[] | Required | Urls |
| formats | string[] | Optional | formats |
| cron | string | Required | Cron expression (5 fields), e.g. '0 9 * * *' |
| timezone | string | Optional | TimezoneDefault: UTC |
| options | object | Optional | options |
| webhook_url | string | Optional | webhook_url |
| session_id | string | Optional | session_id |
| export | object | Optional | Export configuration for schedule results to cloud storage. |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/schedules \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "example_name",
"urls": [],
"cron": "example_cron",
"timezone": "example_timezone"
}'Response Example
JSON
{
"status": "ok"
}GET /api/v1/schedules
GET
/api/v1/schedulesList schedules
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | Optional | limitDefault: 20 |
| offset | integer | Optional | offsetDefault: 0 |
| active_only | boolean | Optional | active_onlyDefault: False |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/schedules \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"schedules": [],
"total": 0
}GET /api/v1/schedules/analytics
GET
/api/v1/schedules/analyticsGet schedule analytics
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/schedules/analytics \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"active_count": 0,
"total_count": 0,
"total_runs_30d": 0,
"success_rate_30d": 0,
"total_credits_30d": 0,
"schedules": []
}GET /api/v1/schedules/{schedule_id}
GET
/api/v1/schedules/{schedule_id}Get schedule details
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"urls": [],
"formats": "example",
"cron": "example",
"timezone": "example"
}PATCH /api/v1/schedules/{schedule_id}
PATCH
/api/v1/schedules/{schedule_id}Update a schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
| name | string | Optional | name |
| urls | string[] | Optional | urls |
| formats | string[] | Optional | formats |
| cron | string | Optional | cron |
| timezone | string | Optional | timezone |
| options | object | Optional | options |
| webhook_url | string | Optional | webhook_url |
| session_id | string | Optional | session_id |
| export | object | Optional | Export configuration for schedule results to cloud storage. |
Request Example
Bash
curl -X PATCH https://api.alterlab.io/api/v1/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"urls": [],
"formats": "example",
"cron": "example",
"timezone": "example"
}DELETE /api/v1/schedules/{schedule_id}
DELETE
/api/v1/schedules/{schedule_id}Delete a schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}POST /api/v1/schedules/{schedule_id}/pause
POST
/api/v1/schedules/{schedule_id}/pausePause a schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/schedules/<schedule_id>/pause \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"urls": [],
"formats": "example",
"cron": "example",
"timezone": "example"
}POST /api/v1/schedules/{schedule_id}/resume
POST
/api/v1/schedules/{schedule_id}/resumeResume a schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/schedules/<schedule_id>/resume \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"urls": [],
"formats": "example",
"cron": "example",
"timezone": "example"
}POST /api/v1/schedules/{schedule_id}/run
POST
/api/v1/schedules/{schedule_id}/runTrigger a schedule now
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/schedules/<schedule_id>/run \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"schedule_id": "example",
"status": "example",
"job_ids": "example",
"batch_id": "example",
"urls_total": 0
}GET /api/v1/schedules/{schedule_id}/runs
GET
/api/v1/schedules/{schedule_id}/runsList schedule runs
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
| limit | integer | Optional | limitDefault: 20 |
| offset | integer | Optional | offsetDefault: 0 |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/schedules/<schedule_id>/runs \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"runs": [],
"total": 0
}