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

Ceramic Experimental API

The Experimental API from Ceramic — 2 operation(s) for experimental.

Ceramic Experimental API is one of 10 APIs that Ceramic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Experimental. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 0.58.0.

Requests are made against a single base URL, /ceramic.

4 operations 2 paths 5 schemas 2 GET2 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.58.0
Base URL
http://localhost:5101/ceramic
License
Resource Areas
1

Paths & Operations 4

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

Experimental 4
OPTIONS
/experimental/interests
cors
1 param → 200
GET
/experimental/interests
Get the interests stored on the node
1 param → 200400500
OPTIONS
/experimental/events/{sep}/{sepValue}
cors
2 params → 200
GET
/experimental/events/{sep}/{sepValue}
Get events matching the interest stored on the node
6 params → 200400500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are EventsGet (3 properties), Event (2 properties), InterestsGet (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

EventsGet
object
Ceramic event keys as part of a Ceramic Stream
3 properties 3 required
BadRequestResponse
object
Bad request (input error)
1 property 1 required
ErrorResponse
object
Error response
1 property 1 required
InterestsGet
object
Ceramic interest keys
1 property 1 required
Event
object
A Ceramic event as part of a Ceramic Stream. Contains both the root CID used to identify the Event as well as the Event payload data.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceramic-experimental-api-openapi.yml Raw ↑

Other APIs Ceramic publishes across the network.

Ceramic Config API
Ceramic Debug API
Ceramic Events API
Ceramic Feed API
Ceramic Interests API
Ceramic Liveness API
Ceramic Peers API
Ceramic Streams API
Ceramic Version API