Actor Model

The Actor Model is a mathematical model of concurrent computation where the fundamental unit of computation is an actor, an entity that processes messages asynchronously and maintains its own private state. It provides a powerful abstraction for building highly concurrent and distributed systems, used in frameworks like Akka and languages like Erlang.

1 APIs 0 Features

Actor ModelConcurrencyDistributed Systems

APIs

Actor Model API

Reference API for actor lifecycle management, message passing, supervision hierarchies, cluster membership, and system health in actor model systems. Applicable to frameworks in...

Collections

Actor Model API

OPEN

Pricing Plans

Actor Model Plans Pricing

3 plans

PLANS

Rate Limits

Actor Model Rate Limits

5 limits

RATE LIMITS

FinOps

Actor Model Finops

FINOPS

Semantic Vocabularies

Actor Model Context

53 classes · 3 properties

JSON-LD

API Governance Rules

Actor Model API Rules

24 rules · 9 errors 12 warnings 3 info

SPECTRAL

JSON Structure

Actor Model Actor List Structure

3 properties

JSON STRUCTURE

Actor Model Actor Message Structure

5 properties

JSON STRUCTURE

Actor Model Actor Structure

10 properties

JSON STRUCTURE

Actor Model Cluster Member List Structure

3 properties

JSON STRUCTURE

Actor Model Cluster Member Structure

6 properties

JSON STRUCTURE

Actor Model Mailbox Inspection Structure

4 properties

JSON STRUCTURE

Actor Model Shard List Structure

3 properties

JSON STRUCTURE

Actor Model Shard Structure

5 properties

JSON STRUCTURE

Actor Model Spawn Actor Request Structure

4 properties

JSON STRUCTURE

Actor Model Supervisor List Structure

3 properties

JSON STRUCTURE

Actor Model Supervisor Structure

7 properties

JSON STRUCTURE

Actor Model System Health Structure

7 properties

JSON STRUCTURE

Example Payloads

Actor Model Actor Example

10 fields

EXAMPLE

Actor Model Actor List Example

3 fields

EXAMPLE

Actor Model Actor Message Example

5 fields

EXAMPLE

Actor Model Cluster Member Example

6 fields

EXAMPLE

Actor Model Cluster Member List Example

3 fields

EXAMPLE

Actor Model Mailbox Inspection Example

4 fields

EXAMPLE

Actor Model Shard Example

5 fields

EXAMPLE

Actor Model Shard List Example

3 fields

EXAMPLE

Actor Model Spawn Actor Request Example

4 fields

EXAMPLE

Actor Model Supervisor Example

7 fields

EXAMPLE

Actor Model Supervisor List Example

3 fields

EXAMPLE

Actor Model System Health Example

7 fields

EXAMPLE

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Actor Model API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Actors
    type: folder
  items:
  - info:
      name: Actor Model List Actors
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/actors
      params:
      - name: status
        value: ''
        type: query
        description: Filter by actor status (active, idle, stopped)
      - name: limit
        value: ''
        type: query
        description: Maximum number of actors to return
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor for next page of results
    docs: List all active actors in the system with their current state and mailbox statistics.
  - info:
      name: Actor Model Spawn Actor
      type: http
    http:
      method: POST
      url: https://api.example.com/actor-system/v1/actors
      body:
        type: json
        data: '{}'
    docs: Spawn a new actor with the specified behavior and optional initial state.
  - info:
      name: Actor Model Get Actor
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/actors/:actorId
      params:
      - name: actorId
        value: ''
        type: path
        description: Unique actor identifier or path
    docs: Retrieve details of a specific actor including its current state, mailbox size, and supervision link.
  - info:
      name: Actor Model Stop Actor
      type: http
    http:
      method: DELETE
      url: https://api.example.com/actor-system/v1/actors/:actorId
      params:
      - name: actorId
        value: ''
        type: path
        description: Unique actor identifier or path
      - name: graceful
        value: ''
        type: query
        description: Whether to drain mailbox before stopping
    docs: Send a stop signal to an actor, gracefully draining its mailbox before termination.
- info:
    name: Mailboxes
    type: folder
  items:
  - info:
      name: Actor Model Inspect Mailbox
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/actors/:actorId/messages
      params:
      - name: actorId
        value: ''
        type: path
        description: Target actor identifier
      - name: limit
        value: ''
        type: query
        description: Number of pending messages to inspect
    docs: Inspect pending messages in an actor's mailbox without consuming them. Useful for debugging.
  - info:
      name: Actor Model Send Message
      type: http
    http:
      method: POST
      url: https://api.example.com/actor-system/v1/actors/:actorId/messages
      params:
      - name: actorId
        value: ''
        type: path
        description: Target actor identifier
      body:
        type: json
        data: '{}'
    docs: Send a message to an actor's mailbox for asynchronous processing.
- info:
    name: Supervisors
    type: folder
  items:
  - info:
      name: Actor Model List Supervisors
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/supervisors
      params:
      - name: limit
        value: ''
        type: query
        description: Maximum number of supervisors to return
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor
    docs: List all supervisor actors with their child counts and supervision strategies.
  - info:
      name: Actor Model Get Supervisor
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/supervisors/:supervisorId
      params:
      - name: supervisorId
        value: ''
        type: path
        description: Supervisor actor identifier
    docs: Retrieve the supervision tree and strategy for a specific supervisor actor.
  - info:
      name: Actor Model List Supervisor Children
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/supervisors/:supervisorId/children
      params:
      - name: supervisorId
        value: ''
        type: path
        description: Supervisor actor identifier
    docs: List all child actors currently under a supervisor's watch.
- info:
    name: Cluster
    type: folder
  items:
  - info:
      name: Actor Model List Cluster Members
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/cluster/members
      params:
      - name: status
        value: ''
        type: query
        description: Filter by member status (up, joining, leaving, down)
    docs: List all nodes in the actor system cluster with their status and roles.
  - info:
      name: Actor Model List Cluster Shards
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/cluster/shards
    docs: List all shards in the cluster with their location and actor count.
- info:
    name: Health
    type: folder
  items:
  - info:
      name: Actor Model Get System Health
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/health
    docs: Get the overall health status of the actor system including actor count, throughput, and error rates.
  - info:
      name: Actor Model Get Readiness
      type: http
    http:
      method: GET
      url: https://api.example.com/actor-system/v1/health/ready
    docs: Kubernetes-compatible readiness probe endpoint for the actor system.
bundled: true