Get Queue

List pending queue messages and queue capacity details.

GET https://api.rivet.dev/gateway/{actor}/inspector/queue

Examples

curl "https://api.rivet.dev/gateway/$ACTOR_ID/inspector/queue?limit=50" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN"

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/queue?limit=50`,
	{ headers: { Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}` } },
);
console.log(await response.json());
export {};

Authentication

Inspector endpoints do not accept namespace tokens. Send the actor’s inspector token as a bearer token in the Authorization header. Each actor generates its own inspector token on first start and stores it in its KV storage under the single byte 0x03. Read it through the control plane with GET /actors/{actor_id}/kv/keys/Aw==?namespace={namespace} using a namespace token; the response value is the token, base64-encoded. The dashboard does this for you.

Path Parameters

Query Parameters

Headers

Actor Selector

{actor} accepts an actor ID, an actor ID with an inline routing token ({actor_id}@{token}), or an actor name combined with the rvt-* query parameters below. See Actor Routing for the full rules.

Responses

200

Queue size, capacity, truncation status, and pending message metadata.

{
  "size": 0,
  "maxSize": 0,
  "truncated": false,
  "messages": [
    {
      "id": "<id>",
      "name": "my-actor",
      "createdAtMs": 0
    }
  ]
}

401

The inspector token is missing or invalid.