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

ActivityPub Inbox API

Receive and read activities delivered to an actor

This API exposes 2 operations across 1 path, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://{domain}.

2 operations 1 paths 9 schemas 1 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://{domain}
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

ActivityPub Inbox API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as Signature (HTTPSignature).

  • BearerAuth — OAuth 2.0 bearer token for client-to-server authentication
  • HTTPSignature — HTTP Signatures (draft-cavage-http-signatures) for server-to-server authentication. The Signature header contains keyId, algorithm, headers, and signature fiel…

Paths & Operations 2

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

Inbox 2

Receive and read activities delivered to an actor

GET
/users/{username}/inbox
Read actor inbox
getInbox 2 params → 200401403
POST
/users/{username}/inbox
Deliver activity to actor inbox (server-to-server)
postToInbox 1 param body → 200201400401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ASObject (21 properties), Actor (18 properties), Activity (15 properties), Collection (8 properties). Each schema is shown below with its type and property counts.

Collection
object
An ActivityStreams 2.0 Collection of Objects or Links
8 properties 2 required
Activity
object
An ActivityStreams 2.0 Activity describing an action performed by an actor. Common activity types: Create, Update, Delete, Follow, Accept, Reject, Announce, Li…
15 properties 3 required
Link
object
An ActivityStreams 2.0 Link, a qualified reference to another resource
6 properties 2 required
ImageObject
object
An ActivityStreams 2.0 Image object
5 properties
OrderedCollection
object
An ActivityStreams 2.0 OrderedCollection with temporally ordered items
8 properties 2 required
ASContext
ActivityStreams 2.0 JSON-LD context
Actor
object
An ActivityPub Actor object representing an entity capable of performing activities. Actor types include Person, Application, Group, Organization, and Service.
18 properties 5 required
ASObject
object
Base ActivityStreams 2.0 Object type. Encompasses Note, Article, Image, Video, Audio, Document, Page, Event, Place, Profile, Relationship, Tombstone, and Quest…
21 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activitypub-inbox-api-openapi.yml Raw ↑