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

Actor Model Actors API

Actor lifecycle and management

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.example.com/actor-system/v1.

4 operations 2 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.example.com/actor-system/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Actor Model Actors API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token for actor system management API access

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Actors 4

Actor lifecycle and management

GET
/actors
Actor Model List Actors
listActors 3 params → 200401
POST
/actors
Actor Model Spawn Actor
spawnActor body → 201400401
GET
/actors/{actorId}
Actor Model Get Actor
getActor 1 param → 200401404
DELETE
/actors/{actorId}
Actor Model Stop Actor
stopActor 2 params → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Actor (10 properties), SpawnActorRequest (4 properties), ActorList (3 properties). Each schema is shown below with its type and property counts.

Actor
object
An actor in the system with its current state and mailbox info
10 properties
SpawnActorRequest
object
Request to spawn a new actor
4 properties 1 required
ActorList
object
Paginated list of actors
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

actor-model-actors-api-openapi.yml Raw ↑