Skip to content

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.

GET/api/v2/worker-runs/{runId}/result/exportExport worker run results
AuthenticationRequired

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

Parameters
path · stringRequired

Run slug returned as `data.run_slug` from start or rerun responses.

query · string · default `csv`Optional

Export format. Constraints: default `csv`.

query · stringOptional

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.

Use this endpoint to export run results as a downloadable file.

  • runId is the run slug. Use data.run_slug from start or rerun responses as the runId.
ParameterRequiredTypeDescription
runIdYesstringRun slug returned as data.run_slug from start or rerun responses.
ParameterRequiredTypeDescription
formatNostringExport format. Defaults to csv. Constraints: default csv.
filter_keysNostringComma-separated field keys used to limit exported fields, for example title,address.
Terminal window
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"
{
"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-key header, and query token. Prefer Bearer token for new integrations.
  • filter_keys can limit exported fields, for example title,address.
  • Result lists use offset and limit pagination.
HTTP StatusApplication CodeMeaning
2000OK
40011000Bad Request
40112001Unauthorized
40411004Not Found
42211000Unprocessable Entity
42913000Too Many Requests
50010000Internal Server Error