Skip to content

Get Worker Run Detail

Method: GET

Endpoint: /api/v2/worker-runs/{runId}

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}Get worker run detail
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.

Request BodyNot applicable
No JSON request body. Fill the path or query parameters above.

Use this endpoint to read or operate on a specific run by runId.

  • 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.
Terminal window
curl -X GET "https://openapi.coreclaw.com/api/v2/worker-runs/YOUR_RUN_ID" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"code": 0,
"data": {
"duration": 10,
"err_msg": "",
"finished_at": 1782091210,
"origin": "openapi",
"results": 1,
"scraper_slug": "demo-worker",
"scraper_title": "Demo Worker",
"slug": "01KKDXV2G26BT7NH4ZQR2R4NPZ",
"started_at": 1782091200,
"status": "running",
"traffic": 0,
"usage": "1.00",
"version": "latest"
},
"message": "success",
"request_id": "req-123"
}

data contains these run fields:

FieldTypeDescription
slugstringRun identifier; pass it as runId to detail, log, result, and export endpoints.
scraper_slugstringIdentifier of the Worker that ran.
scraper_titlestringWorker display name.
versionstringWorker version that actually ran, for example v1.2.8.
statusstringRun status and the primary outcome field. See Run Lifecycle & Status for values.
resultsintegerCurrent or final number of result rows. 0 does not mean failure.
usagestringPlatform-recorded resource usage (numeric string) for observability and billing diagnostics.
trafficintegerPlatform-recorded traffic diagnostic value.
originstringRun origin, for example api_v2.
started_atintegerExecution start time, Unix seconds.
finished_atintegerExecution end time, Unix seconds.
durationintegerExecution duration in seconds.
err_msgstringOptional diagnostic text. It may be absent (successful runs usually omit it); use it only as supporting evidence, never as the sole success/failure signal.

Timestamps are Unix seconds (UTC). Cancellation, queueing, or state synchronization can produce incomplete or non-intuitive timing combinations; always treat status as authoritative.

  • API v2 supports Bearer token, the legacy api-key header, and query token. Prefer Bearer token for new integrations.
  • See Run Lifecycle & Status for status handling, polling, failure diagnosis, and cancellation behavior.
HTTP StatusApplication CodeMeaning
2000OK
40011000Bad Request
40112001Unauthorized
40411004Not Found
42211000Unprocessable Entity
42913000Too Many Requests
50010000Internal Server Error