sparkcrawlDocs

Create a bounded recrawl schedule when automation is enabled

Conditional capability; check capabilities.schedules. Requires crawl scope.

POST
/api/v1/schedules

Conditional capability; check capabilities.schedules. Requires crawl scope.

Authorization

bearerAuth
headerAuthorizationBearer <sc_live_<43 characters>>

Organization API key created at /app/api. Scopes: scrape, crawl, search, research. The secret is shown once.

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 8192
intervalMinutes*integer
Range1 <= value <= 43200

Response Body

Created schedule

application/json
  1. response
id*string
organizationId*string
url*string
Formaturi
intervalMs*integer
nextRunAt*integer
paused*boolean
Example Request
curl -X POST 'https://sparkcrawl.com/api/v1/schedules' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "intervalMinutes": 1}'
Example Response
{  "id": "string",  "organizationId": "string",  "url": "http://example.com",  "intervalMs": 0,  "nextRunAt": 0,  "paused": true}

GET/schedules

Conditional capability: SCRAPING_AUTOMATION_ENABLED=1 and PostgreSQL are required; otherwise returns 503 automation_unavailable. Requires crawl scope.

PATCH/schedules/{id}

Next Page