RIrivet-dev

Send a queue message

Changed on

Enqueue a message on the actor's queue. Optionally wait for the actor to complete it and return its response.

post/gateway/{actor}/queue/{name}

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.

namestring required

Name of the queue message.

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.

Request body

bodyunknown required
waitboolean

Wait for the actor to complete the message and return its response.

timeoutinteger

How long to wait for completion, in milliseconds. Only used with wait.

Response

Message enqueued. When wait is true, also reports whether the actor completed it.

status'completed' | 'timedOut' required

Whether the actor completed the message before the timeout.

responseunknown

Changes