API Reference

The Scrayle REST API provides programmatic access to all platform features.

Base URL

https://api.scrayle.com/api/v1

Authentication

All requests require the x-api-key header:

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.scrayle.com/api/v1/scrape

Response Format

All responses are JSON. Successful responses return status 200:

{
  "success": true,
  "data": { ... }
}

Error Responses

{
  "success": false,
  "error": "Error message describing what went wrong"
}

Rate Limiting

API rate limits depend on your plan. When rate limited, the API returns status 429 with a Retry-After header indicating when you can retry (in seconds).

Endpoints

Pagination

List endpoints support pagination:

GET /api/v1/workflows?page=1&limit=20

Response includes total counts:

{
  "data": [...],
  "total": 150,
  "page": 1,
  "limit": 20
}