Base URL & Authentication

Use https://openapi.coreclaw.com as the HTTP API base URL. Every v2 endpoint path starts with /api/v2, for example https://openapi.coreclaw.com/api/v2/users/account.

https://openapi.coreclaw.com

API V1 is scheduled for retirement, so migrate as soon as possible. Start with the migration guide, replace each old call with the endpoint mapping and change notes, and use the Python, Node.js, Java, PHP, and Go migration examples.

Authenticated endpoints support three token transport modes. Prefer Bearer tokens, while keeping compatibility with the legacy api-key header and query token:

-H "Authorization: Bearer YOUR_API_KEY"

Public endpoints do not require a token, including proxy region lookup and Store Worker search.

• Read the Worker input schema before sending input; fields differ by Worker.
• Use POST /api/v2/workers/{workerId}/runs for a direct Worker run, or POST /api/v2/worker-tasks/{workerTaskId}/runs for a saved task run.
• is_async: true returns immediately; use runId to read details, logs, and results. is_async: false waits for completion and returns a synchronous result window.
• offset is a 1-based page number on list and result endpoints (offset=1 is page 1, offset=0 is accepted as page 1); limit is capped at 100 on list and result endpoints.
• Use export endpoints when the caller needs a downloadable result file instead of fetching every page in a browser.

Most JSON responses include code, message, request_id, and data. HTTP status describes the request layer; application code: 0 means the business operation succeeded. Keep HTTP status, code, message, and request_id when troubleshooting failed requests.