External API Endpoints

This page documents external, user-facing API endpoints intended for automation, integrations, and server-side usage.
All endpoints listed below require an API key.

Authentication#

External access uses API key authentication.

API key is generated from the UI
Sent via headers on every request

Tasks#

List Tasks#

Retrieve available task IDs and names.

GET /api/tasks/list

Run Task#

Execute a saved task externally.

POST /tasks/:id/api

Runs the task exactly as configured in the UI, including:

Mode (scrape / agent)
Proxies & rotation
User agent
Cookies
Storage
Limits

Execution Behavior#

When triggered externally:

A new execution is created
Results are stored the same as UI runs
Screenshots and recordings are captured
Errors are persisted for inspection

Typical Use Cases#

Cron jobs
Backend services
CI pipelines
Webhooks
External orchestrators
No-code tools

Example Flow#

Create and test task in UI
Generate API key
Call POST /tasks/:id/api from your service
Read results from storage or UI

Notes#

Rate limits apply per API key
Tasks must already exist
API keys can be rotated at any time from settings