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.
Try it
Section titled “Try it”GET
/api/v2/workers/{workerId}Get worker detailAuthenticationRequired
Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.
Parameters
Required
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.
When to use this endpoint
Section titled “When to use this endpoint”Use this endpoint to list Workers available to the authenticated user.
Identifier Notes
Section titled “Identifier Notes”workerId/worker_idaccepts a Worker slug or a path encoded asowner~namefromowner/name.
Path Parameters
Section titled “Path Parameters”| Parameter | Required | Type | Description |
|---|---|---|---|
workerId | Yes | string | Worker slug or path. You may paste owner/name; the playground sends it as owner~name for path values. |
Request Example
Section titled “Request Example”curl -X GET "https://openapi.coreclaw.com/api/v2/workers/YOUR_WORKER_ID" \ -H "Authorization: Bearer YOUR_API_KEY"Response Example
Section titled “Response Example”{ "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-keyheader, and query token. Prefer Bearer token for new integrations.
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 |