Rivet

Rivet Gateway API

The Gateway API from Rivet — 12 operation(s) for gateway.

GitHub OpenAPI

Operations 19

GET /gateway/{actorId}/health Get gateway by actor id health #
POST /gateway/{actorId}/action/{action} Create gateway by actor id action by action #
GET /gateway/{actorId}/request/{path} Get gateway by actor id request by path #
POST /gateway/{actorId}/request/{path} Create gateway by actor id request by path #
PUT /gateway/{actorId}/request/{path} Replace gateway by actor id request by path #
DELETE /gateway/{actorId}/request/{path} Delete gateway by actor id request by path #
PATCH /gateway/{actorId}/request/{path} Update gateway by actor id request by path #
HEAD /gateway/{actorId}/request/{path} Check gateway by actor id request by path #
OPTIONS /gateway/{actorId}/request/{path} Describe gateway by actor id request by path #
GET /gateway/{actorId}/inspector/state Get gateway by actor id inspector state #
PATCH /gateway/{actorId}/inspector/state Update gateway by actor id inspector state #
GET /gateway/{actorId}/inspector/connections Get gateway by actor id inspector connections #
GET /gateway/{actorId}/inspector/rpcs Get gateway by actor id inspector rpcs #
POST /gateway/{actorId}/inspector/action/{name} Create gateway by actor id inspector action by name #
GET /gateway/{actorId}/inspector/queue Get gateway by actor id inspector queue #
GET /gateway/{actorId}/inspector/traces Get gateway by actor id inspector traces #
GET /gateway/{actorId}/inspector/workflow-history Get gateway by actor id inspector workflow history #
POST /gateway/{actorId}/inspector/workflow/replay Create gateway by actor id inspector workflow replay #
GET /gateway/{actorId}/inspector/summary Get gateway by actor id inspector summary #

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-gateway-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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rivet:rivet-gateway-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rivet-gateway-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.2.0
  title: RivetKit Gateway API
tags:
- name: Gateway
paths:
  /gateway/{actorId}/health:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      responses:
        '200':
          description: Health check
          content:
            text/plain:
              schema:
                type: string
      tags:
      - Gateway
      summary: Get gateway by actor id health
      x-summary-source: derived
      operationId: getGatewayByActorIdHealth
      x-operation-id-source: derived
  /gateway/{actorId}/action/{action}:
    post:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: action
        in: path
        required: true
        schema:
          type: string
        description: The name of the action to execute
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                args: {}
              required:
              - args
              additionalProperties: false
      responses:
        '200':
          description: Action executed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  output: {}
                required:
                - output
                additionalProperties: false
        '400':
          description: Invalid action
        '500':
          description: Internal error
      tags:
      - Gateway
      summary: Create gateway by actor id action by action
      x-summary-source: derived
      operationId: postGatewayByActorIdActionByAction
      x-operation-id-source: derived
  /gateway/{actorId}/request/{path}:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Get gateway by actor id request by path
      x-summary-source: derived
      operationId: getGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    post:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Create gateway by actor id request by path
      x-summary-source: derived
      operationId: postGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    put:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Replace gateway by actor id request by path
      x-summary-source: derived
      operationId: putGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    delete:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Delete gateway by actor id request by path
      x-summary-source: derived
      operationId: deleteGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    patch:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Update gateway by actor id request by path
      x-summary-source: derived
      operationId: patchGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    head:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Check gateway by actor id request by path
      x-summary-source: derived
      operationId: headGatewayByActorIdRequestByPath
      x-operation-id-source: derived
    options:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: path
        in: path
        required: true
        schema:
          type: string
        description: The HTTP path to forward to the actor
      responses:
        '200':
          description: Response from actor's raw HTTP handler
      tags:
      - Gateway
      summary: Describe gateway by actor id request by path
      x-summary-source: derived
      operationId: optionsGatewayByActorIdRequestByPath
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/state:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Current actor state
          content:
            application/json:
              schema:
                type: object
                properties:
                  state: {}
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector state
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorState
      x-operation-id-source: derived
    patch:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                state: {}
              required:
              - state
      responses:
        '200':
          description: State updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Update gateway by actor id inspector state
      x-summary-source: derived
      operationId: patchGatewayByActorIdInspectorState
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/connections:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Current actor connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  connections:
                    type: array
                    items:
                      type: object
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector connections
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorConnections
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/rpcs:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Available actor actions/RPCs
          content:
            application/json:
              schema:
                type: object
                properties:
                  rpcs:
                    type: object
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector rpcs
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorRpcs
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/action/{name}:
    post:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: The name of the action to execute
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                args:
                  type: array
                  items: {}
      responses:
        '200':
          description: Action executed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  output: {}
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Create gateway by actor id inspector action by name
      x-summary-source: derived
      operationId: postGatewayByActorIdInspectorActionByName
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/queue:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
        description: Maximum number of queue messages to return
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Queue status
          content:
            application/json:
              schema:
                type: object
                properties:
                  size:
                    type: integer
                  maxSize:
                    type: integer
                  truncated:
                    type: boolean
                  messages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        createdAtMs:
                          type: integer
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector queue
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorQueue
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/traces:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: startMs
        in: query
        required: false
        schema:
          type: integer
          default: 0
        description: Start of time range in epoch milliseconds
      - name: endMs
        in: query
        required: false
        schema:
          type: integer
        description: End of time range in epoch milliseconds. Defaults to now.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 1000
        description: Maximum number of spans to return
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Trace spans in OTLP JSON format
          content:
            application/json:
              schema:
                type: object
                properties:
                  otlp:
                    type: object
                  clamped:
                    type: boolean
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector traces
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorTraces
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/workflow-history:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Workflow history and status
          content:
            application/json:
              schema:
                type: object
                properties:
                  history: {}
                  isWorkflowEnabled:
                    type: boolean
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector workflow history
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorWorkflowHistory
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/workflow/replay:
    post:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                entryId:
                  type: string
      responses:
        '200':
          description: Workflow history after scheduling a replay
          content:
            application/json:
              schema:
                type: object
                properties:
                  history: {}
                  isWorkflowEnabled:
                    type: boolean
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Create gateway by actor id inspector workflow replay
      x-summary-source: derived
      operationId: postGatewayByActorIdInspectorWorkflowReplay
      x-operation-id-source: derived
  /gateway/{actorId}/inspector/summary:
    get:
      parameters:
      - name: actorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the actor to target
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for inspector authentication. Required in production, optional in development.
      responses:
        '200':
          description: Full actor inspector summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  state: {}
                  connections:
                    type: array
                    items:
                      type: object
                  rpcs:
                    type: object
                  queueSize:
                    type: integer
                  isStateEnabled:
                    type: boolean
                  isDatabaseEnabled:
                    type: boolean
                  isWorkflowEnabled:
                    type: boolean
                  workflowHistory: {}
        '401':
          description: Unauthorized
      tags:
      - Gateway
      summary: Get gateway by actor id inspector summary
      x-summary-source: derived
      operationId: getGatewayByActorIdInspectorSummary
      x-operation-id-source: derived