RIrivet-dev
actors::get_or_create

Returns the live actor with the given name and key, or creates it. Waking a sleeping actor is part of the lookup. Without a key, a new actor is always created.

Changed on
put/actors

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/actors
  • Auth
    • HTTP bearer
    • or API key in header x-rivet-token

Query parameters

namespacestring

Name of the namespace to operate in. Defaults to default.

Request body

namestring required

Actor name, 1 to 64 bytes.

keystring nullable

Actor key in canonical slash-separated form, at most 1024 bytes. Without a key, a new actor is always created.

inputstring nullable

Actor input as standard base64 (with padding).

poolstring nullable

Name of the node pool to run the actor in. Defaults to default.

Response

The existing or created actor.

createdboolean required

true if this request created the actor, false if it already existed.

Example response

{
  "actor": {
    "actor_id": "d97pbq1nyqxw1w5qdwz0iirbqiblh2"
  }
}

Changes

  • aa8d1a8a5d14Revision changes
    • breaking

      added the pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ to the query request parameter namespace

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      for the query request parameter namespace, the maxLength was set to 63

    • warning

      the request property's maxLength was set to 1024

    • warning

      the request property's maxLength was set to 64

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • info

      the endpoint scheme security rivet_token_header was added to the API

    • info

      added the new optional request property

    • info

      the query request parameter namespace became optional

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • b4575371d0d8Revision changes
    • info

      the endpoint scheme security bearer_auth was added to the API