API Reference

Auto-generated

Crawl

API reference for crawl endpoints.

Auto-generated

This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

POST /api/v1/crawl/schedules

POST

/api/v1/crawl/schedules

Create Crawl Schedule

Parameters

Name	Type	Required	Description
name	`string`	Required	Name
cron	`string`	Required	Cron expression (5 fields), e.g. '0 6 * * *'
timezone	`string`	Optional	TimezoneDefault: `UTC`
crawl_config	`object`	Required	Frozen crawl configuration executed on each scheduled run. Mirrors the essential fields of CrawlRequest but stored as a JSON blob so the schedule is self-contained (no user input at execution time).
max_runs	`integer`	Optional	max_runs
max_credits_per_run	`integer`	Optional	max_credits_per_run
enabled	`boolean`	Optional	EnabledDefault: `True`

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/schedules \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example_name",
    "cron": "example_cron",
    "timezone": "example_timezone",
    "crawl_config": "..."
  }'

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/crawl/schedules

GET

/api/v1/crawl/schedules

List Crawl 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/crawl/schedules \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "schedules": [],
  "total": 0
}

GET /api/v1/crawl/schedules/{schedule_id}

GET

/api/v1/crawl/schedules/{schedule_id}

Get Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

PATCH /api/v1/crawl/schedules/{schedule_id}

PATCH

/api/v1/crawl/schedules/{schedule_id}

Update Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id
name	`string`	Optional	name
cron	`string`	Optional	cron
timezone	`string`	Optional	timezone
crawl_config	`object`	Optional	Frozen crawl configuration executed on each scheduled run. Mirrors the essential fields of CrawlRequest but stored as a JSON blob so the schedule is self-contained (no user input at execution time).
max_runs	`integer`	Optional	max_runs
max_credits_per_run	`integer`	Optional	max_credits_per_run
enabled	`boolean`	Optional	enabled

Request Example

Bash

curl -X PATCH https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

DELETE /api/v1/crawl/schedules/{schedule_id}

DELETE

/api/v1/crawl/schedules/{schedule_id}

Delete Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X DELETE https://api.alterlab.io/api/v1/crawl/schedules/<schedule_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

POST /api/v1/crawl/schedules/{schedule_id}/pause

POST

/api/v1/crawl/schedules/{schedule_id}/pause

Pause Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

POST /api/v1/crawl/schedules/{schedule_id}/resume

POST

/api/v1/crawl/schedules/{schedule_id}/resume

Resume Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

POST /api/v1/crawl/schedules/{schedule_id}/run

POST

/api/v1/crawl/schedules/{schedule_id}/run

Run Crawl 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/crawl/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",
  "crawl_id": "example",
  "pages_total": 0,
  "pages_completed": 0
}

GET /api/v1/crawl/schedules/{schedule_id}/runs

GET

/api/v1/crawl/schedules/{schedule_id}/runs

List Crawl 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/crawl/schedules/<schedule_id>/runs \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "runs": [],
  "total": 0
}

Last updated: March 2026

API Reference

Auto-generated

Crawl

API reference for crawl endpoints.

Auto-generated

This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

POST /api/v1/crawl/schedules

POST

/api/v1/crawl/schedules

Create Crawl Schedule

Parameters

Name	Type	Required	Description
name	`string`	Required	Name
cron	`string`	Required	Cron expression (5 fields), e.g. '0 6 * * *'
timezone	`string`	Optional	TimezoneDefault: `UTC`
crawl_config	`object`	Required	Frozen crawl configuration executed on each scheduled run. Mirrors the essential fields of CrawlRequest but stored as a JSON blob so the schedule is self-contained (no user input at execution time).
max_runs	`integer`	Optional	max_runs
max_credits_per_run	`integer`	Optional	max_credits_per_run
enabled	`boolean`	Optional	EnabledDefault: `True`

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/schedules \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example_name",
    "cron": "example_cron",
    "timezone": "example_timezone",
    "crawl_config": "..."
  }'

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/crawl/schedules

GET

/api/v1/crawl/schedules

List Crawl 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/crawl/schedules \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "schedules": [],
  "total": 0
}

GET /api/v1/crawl/schedules/{schedule_id}

GET

/api/v1/crawl/schedules/{schedule_id}

Get Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

PATCH /api/v1/crawl/schedules/{schedule_id}

PATCH

/api/v1/crawl/schedules/{schedule_id}

Update Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id
name	`string`	Optional	name
cron	`string`	Optional	cron
timezone	`string`	Optional	timezone
crawl_config	`object`	Optional	Frozen crawl configuration executed on each scheduled run. Mirrors the essential fields of CrawlRequest but stored as a JSON blob so the schedule is self-contained (no user input at execution time).
max_runs	`integer`	Optional	max_runs
max_credits_per_run	`integer`	Optional	max_credits_per_run
enabled	`boolean`	Optional	enabled

Request Example

Bash

curl -X PATCH https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

DELETE /api/v1/crawl/schedules/{schedule_id}

DELETE

/api/v1/crawl/schedules/{schedule_id}

Delete Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X DELETE https://api.alterlab.io/api/v1/crawl/schedules/<schedule_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

POST /api/v1/crawl/schedules/{schedule_id}/pause

POST

/api/v1/crawl/schedules/{schedule_id}/pause

Pause Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

POST /api/v1/crawl/schedules/{schedule_id}/resume

POST

/api/v1/crawl/schedules/{schedule_id}/resume

Resume Crawl Schedule

Parameters

Name	Type	Required	Description
schedule_id	`string`	Required	schedule_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/crawl/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",
  "crawl_config": {},
  "max_runs": "example"
}

POST /api/v1/crawl/schedules/{schedule_id}/run

POST

/api/v1/crawl/schedules/{schedule_id}/run

Run Crawl 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/crawl/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",
  "crawl_id": "example",
  "pages_total": 0,
  "pages_completed": 0
}

GET /api/v1/crawl/schedules/{schedule_id}/runs

GET

/api/v1/crawl/schedules/{schedule_id}/runs

List Crawl 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/crawl/schedules/<schedule_id>/runs \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "runs": [],
  "total": 0
}

Last updated: March 2026