Export Worker Run Results
Method: GET
Endpoint: /api/v2/worker-runs/{runId}/result/export
Authentication: Supports Authorization: Bearer <YOUR_API_KEY>, api-key: <YOUR_API_KEY>, and ?token=<YOUR_API_KEY>. Prefer Bearer token.
Try it
Section titled “Try it”GET
/api/v2/worker-runs/{runId}/result/exportExport worker run resultsAuthenticationRequired
Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.
Parameters
Required
Run slug returned as `data.run_slug` from start or rerun responses.
Optional
Export format. Constraints: default `csv`.
Optional
Comma-separated field keys used to limit exported fields, for example `title,address`.
Request BodyNot applicable
No JSON request body. Fill the path or query parameters above.
When to use this endpoint
Section titled “When to use this endpoint”Use this endpoint to export run results as a downloadable file.
Identifier Notes
Section titled “Identifier Notes”runIdis the run slug. Usedata.run_slugfrom start or rerun responses as therunId.
Path Parameters
Section titled “Path Parameters”| Parameter | Required | Type | Description |
|---|---|---|---|
runId | Yes | string | Run slug returned as data.run_slug from start or rerun responses. |
Query Parameters
Section titled “Query Parameters”| Parameter | Required | Type | Description |
|---|---|---|---|
format | No | string | Export format. Defaults to csv. Constraints: default csv. |
filter_keys | No | string | Comma-separated field keys used to limit exported fields, for example title,address. |
Request Example
Section titled “Request Example”curl -X GET "https://openapi.coreclaw.com/api/v2/worker-runs/YOUR_RUN_ID/result/export?format=csv&filter_keys=title%2Caddress" \ -H "Authorization: Bearer YOUR_API_KEY"Response Example
Section titled “Response Example”{ "code": 0, "data": { "download_url": "https://storage.example.com/runs/01KKDXV2G26BT7NH4ZQR2R4NPZ/results.csv" }, "message": "success", "request_id": "req-123"}- API v2 supports Bearer token, the legacy
api-keyheader, and query token. Prefer Bearer token for new integrations. filter_keyscan limit exported fields, for exampletitle,address.- Result lists use
offsetandlimitpagination.
HTTP Responses
Section titled “HTTP Responses”| HTTP Status | Application Code | Meaning |
|---|---|---|
200 | 0 | OK |
400 | 11000 | Bad Request |
401 | 12001 | Unauthorized |
404 | 11004 | Not Found |
422 | 11000 | Unprocessable Entity |
429 | 13000 | Too Many Requests |
500 | 10000 | Internal Server Error |