AlterLabAPI Reference
Auto-generated
Search Schedules
API reference for search schedules endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.POST /api/v1/search/schedules
POST
/api/v1/search/schedulesCreate a search schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| X-Organization-Id | string | Optional | X-Organization-Id |
| name | string | Required | Name |
| cron | string | Required | Cron expression (5 fields), e.g. '0 9 * * *' |
| timezone | string | Optional | TimezoneDefault: UTC |
| search_config | object | Required | Frozen search configuration executed on each scheduled run. The legacy fields plus the unified SearchRequest options (#39316), stored as a JSON blob so the schedule is self-contained (no user input at execution time). |
| webhook_url | string | Optional | webhook_url |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/search/schedules \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "example_name",
"cron": "example_cron",
"timezone": "example_timezone",
"search_config": "..."
}'Response Example
JSON
{
"status": "ok"
}GET /api/v1/search/schedules
GET
/api/v1/search/schedulesList search 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/search/schedules \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"schedules": [],
"total": 0
}GET /api/v1/search/schedules/{schedule_id}
GET
/api/v1/search/schedules/{schedule_id}Get search 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/search/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"cron": "example",
"timezone": "example",
"search_config": "example",
"webhook_url": "example"
}PATCH /api/v1/search/schedules/{schedule_id}
PATCH
/api/v1/search/schedules/{schedule_id}Update a search schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
| name | string | Optional | name |
| cron | string | Optional | cron |
| timezone | string | Optional | timezone |
| search_config | object | Optional | Frozen search configuration executed on each scheduled run. The legacy fields plus the unified SearchRequest options (#39316), stored as a JSON blob so the schedule is self-contained (no user input at execution time). |
| webhook_url | string | Optional | webhook_url |
| enabled | boolean | Optional | enabled |
Request Example
Bash
curl -X PATCH https://api.alterlab.io/api/v1/search/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"cron": "example",
"timezone": "example",
"search_config": "example",
"webhook_url": "example"
}DELETE /api/v1/search/schedules/{schedule_id}
DELETE
/api/v1/search/schedules/{schedule_id}Delete a search schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/search/schedules/<schedule_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}POST /api/v1/search/schedules/{schedule_id}/pause
POST
/api/v1/search/schedules/{schedule_id}/pausePause a search schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/search/schedules/<schedule_id>/pause \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"cron": "example",
"timezone": "example",
"search_config": "example",
"webhook_url": "example"
}POST /api/v1/search/schedules/{schedule_id}/resume
POST
/api/v1/search/schedules/{schedule_id}/resumeResume a paused search schedule
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/search/schedules/<schedule_id>/resume \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"cron": "example",
"timezone": "example",
"search_config": "example",
"webhook_url": "example"
}POST /api/v1/search/schedules/{schedule_id}/run
POST
/api/v1/search/schedules/{schedule_id}/runManually trigger a search schedule run
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_id | string | Required | schedule_id |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/search/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_id": "example",
"results_count": 0,
"credits_used": 0
}GET /api/v1/search/schedules/{schedule_id}/runs
GET
/api/v1/search/schedules/{schedule_id}/runsList search schedule run history
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/search/schedules/<schedule_id>/runs \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"runs": [],
"total": 0
}