Rivet

Rivet Actors API

The Actors API from Rivet — 3 operation(s) for actors.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.rivet.dev/docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/authentication/rivet-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/openapi/rivet-actors-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/asyncapi/rivet-rivetkit-asyncapi.json

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/errors/rivet-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/conventions/rivet-conventions.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/rivet/refs/heads/main/apis.yml

OpenAPI Specification

rivet-actors-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 2.2.0
  title: RivetKit Actors API
tags:
- name: Actors
paths:
  /actors:
    get:
      parameters:
      - schema:
          type: string
        required: false
        name: name
        in: query
      - schema:
          type: string
        required: false
        name: actor_ids
        in: query
      - schema:
          type: string
        required: false
        name: key
        in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  actors:
                    type: array
                    items:
                      type: object
                      properties:
                        actor_id:
                          type: string
                        name:
                          type: string
                        key:
                          type: string
                        namespace_id:
                          type: string
                        runner_name_selector:
                          type: string
                        create_ts:
                          type: number
                        connectable_ts:
                          type: number
                          nullable: true
                        destroy_ts:
                          type: number
                          nullable: true
                        sleep_ts:
                          type: number
                          nullable: true
                        start_ts:
                          type: number
                          nullable: true
                        error:
                          nullable: true
                      required:
                      - actor_id
                      - name
                      - key
                      - namespace_id
                      - runner_name_selector
                      - create_ts
                required:
                - actors
        '400':
          description: User error
        '500':
          description: Internal error
      tags:
      - Actors
    put:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                datacenter:
                  type: string
                name:
                  type: string
                key:
                  type: string
                runner_name_selector:
                  type: string
                crash_policy:
                  type: string
                input:
                  type: string
                  nullable: true
              required:
              - name
              - key
              - runner_name_selector
              - crash_policy
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  actor:
                    type: object
                    properties:
                      actor_id:
                        type: string
                      name:
                        type: string
                      key:
                        type: string
                      namespace_id:
                        type: string
                      runner_name_selector:
                        type: string
                      create_ts:
                        type: number
                      connectable_ts:
                        type: number
                        nullable: true
                      destroy_ts:
                        type: number
                        nullable: true
                      sleep_ts:
                        type: number
                        nullable: true
                      start_ts:
                        type: number
                        nullable: true
                      error:
                        nullable: true
                    required:
                    - actor_id
                    - name
                    - key
                    - namespace_id
                    - runner_name_selector
                    - create_ts
                  created:
                    type: boolean
                required:
                - actor
                - created
        '400':
          description: User error
        '500':
          description: Internal error
      tags:
      - Actors
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                datacenter:
                  type: string
                name:
                  type: string
                runner_name_selector:
                  type: string
                crash_policy:
                  type: string
                key:
                  type: string
                  nullable: true
                input:
                  type: string
                  nullable: true
              required:
              - name
              - runner_name_selector
              - crash_policy
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  actor:
                    type: object
                    properties:
                      actor_id:
                        type: string
                      name:
                        type: string
                      key:
                        type: string
                      namespace_id:
                        type: string
                      runner_name_selector:
                        type: string
                      create_ts:
                        type: number
                      connectable_ts:
                        type: number
                        nullable: true
                      destroy_ts:
                        type: number
                        nullable: true
                      sleep_ts:
                        type: number
                        nullable: true
                      start_ts:
                        type: number
                        nullable: true
                      error:
                        nullable: true
                    required:
                    - actor_id
                    - name
                    - key
                    - namespace_id
                    - runner_name_selector
                    - create_ts
                required:
                - actor
        '400':
          description: User error
        '500':
          description: Internal error
      tags:
      - Actors
  /actors/names:
    get:
      parameters:
      - schema:
          type: string
        required: true
        name: namespace
        in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  names:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        metadata:
                          type: object
                          additionalProperties:
                            nullable: true
                      required:
                      - metadata
                required:
                - names
        '400':
          description: User error
        '500':
          description: Internal error
      tags:
      - Actors
  /actors/{actor_id}/kv/keys/{key}:
    get:
      parameters:
      - schema:
          type: string
        required: true
        name: actor_id
        in: path
      - schema:
          type: string
        required: true
        name: key
        in: path
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: string
                    nullable: true
                required:
                - value
        '400':
          description: User error
        '500':
          description: Internal error
      tags:
      - Actors