RIrivet-dev

Get runtime metadata

Changed on

Identify the RivetKit runtime serving the actor.

get/gateway/{actor}/metadata

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

actorstring required

Actor ID, actor ID with @routing-token, or actor name used with the rvt-* selector query parameters.

Query parameters

rvt-namespacestring

Engine namespace. Required when actor selects an actor name.

rvt-method'get' | 'getOrCreate'

Actor-name resolution method. Use get, or getOrCreate with rvt-pool or rvt-runner.

rvt-keystring

Comma-separated actor key components for actor-name resolution.

rvt-poolstring

Pool name. Required for getOrCreate unless rvt-runner is supplied.

rvt-runnerstring

Legacy runner name accepted as the pool selector for getOrCreate.

rvt-inputstring

Base64url-encoded CBOR actor input for getOrCreate.

rvt-regionstring

Preferred region for getOrCreate.

rvt-crash-policy'restart' | 'sleep' | 'destroy'

Crash policy for getOrCreate.

rvt-skip-ready-waitboolean

Return after resolution without waiting for actor readiness.

rvt-tokenstring

Routing token. Credentials should be supplied by a trusted client provider, not constructed by models.

Response

Runtime metadata

runtimestring required

Always rivetkit.

versionstring required

RivetKit version.

typestring required

Runtime flavor, such as native or wasm.

Changes