Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rivet Gateway API

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

Rivet Gateway API is one of 2 APIs that Rivet publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Gateway. The published artifact set on APIs.io includes an OpenAPI specification, an AsyncAPI specification, API documentation, and authentication docs.

This API exposes 19 operations across 12 paths. It is described by OpenAPI 3.0.0, at version 2.2.0.

Requests are made against the base URL https://api.rivet.dev.

19 operations 12 paths 0 schemas 1 DELETE9 GET1 HEAD1 OPTIONS2 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.2.0
Base URL
https://api.rivet.dev
Resource Areas
1

Paths & Operations 19

Across 12 paths, the API surfaces 19 operations — 1 DELETE, 9 GET, 1 HEAD, 1 OPTIONS, 2 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Gateway 19
GET
/gateway/{actorId}/health
1 param → 200
POST
/gateway/{actorId}/action/{action}
2 params body → 200400500
GET
/gateway/{actorId}/request/{path}
2 params → 200
POST
/gateway/{actorId}/request/{path}
2 params → 200
PUT
/gateway/{actorId}/request/{path}
2 params → 200
DELETE
/gateway/{actorId}/request/{path}
2 params → 200
PATCH
/gateway/{actorId}/request/{path}
2 params → 200
HEAD
/gateway/{actorId}/request/{path}
2 params → 200
OPTIONS
/gateway/{actorId}/request/{path}
2 params → 200
GET
/gateway/{actorId}/inspector/state
2 params → 200401
PATCH
/gateway/{actorId}/inspector/state
2 params body → 200401
GET
/gateway/{actorId}/inspector/connections
2 params → 200401
GET
/gateway/{actorId}/inspector/rpcs
2 params → 200401
POST
/gateway/{actorId}/inspector/action/{name}
3 params body → 200401
GET
/gateway/{actorId}/inspector/queue
3 params → 200401
GET
/gateway/{actorId}/inspector/traces
5 params → 200401
GET
/gateway/{actorId}/inspector/workflow-history
2 params → 200401
POST
/gateway/{actorId}/inspector/workflow/replay
2 params body → 200401
GET
/gateway/{actorId}/inspector/summary
2 params → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rivet-gateway-api-openapi.yml Raw ↑

Other APIs Rivet publishes across the network.

Rivet Actors API