Skip to content

Get Worker Detail

Method: GET

Endpoint: /api/v2/workers/{workerId}

Authentication: Supports Authorization: Bearer <YOUR_API_KEY>, api-key: <YOUR_API_KEY>, and ?token=<YOUR_API_KEY>. Prefer Bearer token.

GET/api/v2/workers/{workerId}Get worker detail
AuthenticationRequired

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

Parameters
path · stringRequired

Worker slug or path. You may paste `owner/name`; the playground sends it as `owner~name` for path values.

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

Use this endpoint to list Workers available to the authenticated user.

  • workerId / worker_id accepts a Worker slug or a path encoded as owner~name from owner/name.
ParameterRequiredTypeDescription
workerIdYesstringWorker slug or path. You may paste owner/name; the playground sends it as owner~name for path values.
Terminal window
curl -X GET "https://openapi.coreclaw.com/api/v2/workers/YOUR_WORKER_ID" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"code": 0,
"data": {
"name": "demo-worker",
"parameters": {
"custom": {
"type": "object"
},
"system": {
"proxy_region": "US"
}
},
"readme": "Demo worker readme",
"username": "owner",
"version": "latest"
},
"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.
HTTP StatusApplication CodeMeaning
2000OK
40011000Bad Request
40112001Unauthorized
40411004Not Found
42211000Unprocessable Entity
42913000Too Many Requests
50010000Internal Server Error