Knowledge Base
Browse the concepts behind Truestamp. Follow the links between concepts, or search across everything.
Tagged: api-key
10
API
Beacon API
The authenticated programmatic beacon surfaces - JSON:API endpoints under /api/json/beacons (list, latest, by id, by hash), the equivalent GraphQL queries, the four-field beacon object, error and rate-limit behavior including the rate_limited code, and beacon proof generation by block id.
Console WebSocket Surface
The authenticated multiplexed console WebSocket at /console/websocket, its stream catalog, inbound commands (subscribe, items.create, items.watch), outbound stream events, first-event-immediate burst coalescer, per-connection stream and payload caps, and per-account command and outbound rate limits.
GraphQL API
The authenticated GraphQL endpoint at /gql and its interactive playground, requiring an API key or OAuth bearer token, with queries and mutations auto-generated from the Truestamp resource domains and an introspectable schema.
JSON:API HTTP Surface
The authenticated JSON:API REST surface at /api/json, its API-key or OAuth bearer auth, the OpenAPI spec plus Swagger UI and ReDoc discovery pages, resource-oriented endpoints, tenant selection, filtering, and pagination conventions.
Glossary
API key
A long-lived opaque credential (prefix truestamp_) that authenticates programmatic requests as your whole account, sent as an Authorization Bearer header on JSON:API and GraphQL or as a connection parameter on the console WebSocket; the MCP surface never accepts one and requires OAuth 2.1.
Console (WebSocket)
The authenticated multiplexed WebSocket surface at /console/websocket for real-time programmatic access, where clients subscribe to live streams, issue commands such as items.create and items.watch, and receive stream events under per-connection rate, stream, and payload limits.
GraphQL
Truestamp's authenticated GraphQL endpoint at /gql with an interactive playground at /gql/playground, accepting an API key or OAuth 2.1 bearer token, whose introspectable schema of queries and mutations is generated from the same resource domains as the JSON:API.
JSON:API
Truestamp's authenticated REST surface at /api/json following the JSON:API specification, with API-key or OAuth 2.1 bearer authentication, an OpenAPI spec rendered by Swagger UI and ReDoc, and resource endpoints with standard filtering, sorting, and pagination.