Invoke Action
Invoke an actor action through the inspector.
The inspector API powers the Rivet dashboard and is subject to change without notice. Do not build production integrations on it.
POST https://api.rivet.dev/gateway/{actor}/inspector/action/{name}
Examples
curl -X POST "https://api.rivet.dev/gateway/$ACTOR_ID/inspector/action/increment" \
-H "Authorization: Bearer $INSPECTOR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"args": [
1
]
}'
const endpoint = "https://api.rivet.dev";
const response = await fetch(
`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/action/increment`,
{
method: "POST",
headers: {
Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ args: [1] }),
},
);
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
| Name | Type | Required | Description |
|---|---|---|---|
actor | string | Yes | Actor ID, actor ID with an inline token ({actor_id}@{token}), or actor name combined with the rvt-* query parameters. |
name | string | Yes | Name of the action to invoke. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | No | Bearer token for inspector authentication. Required in production, optional in development. |
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.
Request Body
Content type: application/json (optional).
| Field | Type | Required | Description |
|---|---|---|---|
args | any[] | No | Positional arguments passed to the action, in order. |
Responses
200
The action result.
| Field | Type | Description |
|---|---|---|
output | any | Value returned by the action. null if the action returned undefined. |
{
"output": 1
}
401
The inspector token is missing or invalid.