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 Actors API

Retrieve actor profile objects

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

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

1 operations 1 paths 4 schemas 1 GET

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 Actors 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 1

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

Actors 1

Retrieve actor profile objects

GET
/users/{username}
Retrieve actor profile
getActor 1 param → 200404403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Actor (18 properties), ImageObject (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

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
Error
object
2 properties
ImageObject
object
An ActivityStreams 2.0 Image object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activitypub-actors-api-openapi.yml Raw ↑