Activate Run Queue Items

Method: POST

Endpoint: /api/v2/run-queue/items/activate

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

Try it

POST/api/v2/run-queue/items/activateActivate run queue items

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

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

Request BodyRequiredapplication/json

FieldTypeRequiredDescription

queue_refsarrayRequiredQueue item IDs.

Request body (JSON)Reset to example

{ "queue_refs": [] }

Send Request Clear all

When to use this endpoint

Use this endpoint to start one or more runs that are sitting in the Run Queue. Items normally enter the queue in the waiting state — for example, when a run was submitted but the account balance was insufficient at the time, the run is held in waiting instead of executing. Once the blocking condition is resolved (e.g. you topped up the balance), call this endpoint to actually start the run.

First call List Run Queue Items to get the queue_ref of the items you want to activate.

Request Body

Send the request body with Content-Type: application/json.

Field	Required	Type	Description
queue_refs	Yes	array<string>	The queue item IDs to activate. Copy these from the queue_ref values returned by List Run Queue Items.

JSON Example

{
  "queue_refs": ["123456", "123457"]
}

Request Example

curl -X POST "https://openapi.coreclaw.com/api/v2/run-queue/items/activate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"queue_refs":["123456","123457"]}'

Response Example

{
  "code": 0,
  "data": {
    "results": [
      { "queue_ref": "123456", "success": true },
      { "queue_ref": "123457", "success": false }
    ]
  },
  "message": "success",
  "request_id": "req-123"
}

Response Fields

Field	Type	Description
data.results[]	array	Per-item activation outcomes, one entry per queue_ref you submitted.
data.results[].queue_ref	string	The queue item ID this result refers to.
data.results[].success	boolean	Whether the item was activated. false when the item was no longer in a waiting state (for example it already ran or was released).

Notes

• API v2 supports Bearer token, the legacy api-key header, and query token. Prefer Bearer token for new integrations.
• This is a batch operation: every queue_ref in the array is activated in one call.
• To remove items from the queue instead of running them, use Release Run Queue Items.
• After activation, poll the run status via the run detail/log/result endpoints. See Run Lifecycle & Status.

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