Trawl docs
API reference
Trawl API.
AI web extraction as an async job API. Every endpoint, request, and response — generated from the live OpenAPI spec.
Base URL
https://api.trawl.productcraft.coAuth
Authorization: Bearer …Spec version
OpenAPI 3.0.0 · v0.1.0
OpenAPI spec
https://api.trawl.productcraft.co/docs-jsonCredits
The workspace's Trawl credit balance and recent ledger entries.
Jobs
Extraction jobs: submit a URL and a JSON Schema, then read the structured result when the job completes.
Stats
Usage totals and a time series for the workspace dashboard.
Webhooks
Webhook endpoints that receive `job.succeeded`, `job.failed` and `credits.low` events, their delivery log and replays. The legacy single-webhook routes are deprecated.
- get
/v1/workspaces/{workspace_id}/webhooks/event-typesList the events an endpoint can subscribe to. - get
/v1/workspaces/{workspace_id}/webhooks/endpointsList webhook endpoints, oldest first. - post
/v1/workspaces/{workspace_id}/webhooks/endpointsAdd a webhook endpoint. - get
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Get one webhook endpoint (without its secret). - patch
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Change a webhook endpoint: URL, description, events, on/off. - delete
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Delete a webhook endpoint. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/testSend a test event to this endpoint now and return the result. - get
/v1/workspaces/{workspace_id}/webhooks/eventsList webhook events, newest first (kept for 30 days). - get
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}Get one webhook event with every delivery attempt. - post
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}/replaySend a logged event again, to its endpoints or to one endpoint. - get
/v1/workspaces/{workspace_id}/webhooksList webhooks for the workspace (paginated, newest first, secrets masked) - post
/v1/workspaces/{workspace_id}/webhooksCreate a workspace webhook. - get
/v1/workspaces/{workspace_id}/webhooks/{id}Get a webhook (secret masked) - patch
/v1/workspaces/{workspace_id}/webhooks/{id}Update url / active flag (active=true clears auto-disable) - delete
/v1/workspaces/{workspace_id}/webhooks/{id}Delete a webhook - get
/v1/workspaces/{workspace_id}/webhooks/{id}/deliveriesDelivery attempts for a webhook (paginated, default 50, max 200, newest first) - post
/v1/workspaces/{workspace_id}/webhooks/{id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/webhooks/{id}/testSend the `job.succeeded` example to this webhook; the attempt shows in `/deliveries`