Skip to main content
The Mirador REST API is a read-only HTTP API for querying your traces, their event timelines, and project metadata. It’s the companion to the ingest SDKs: the SDKs write traces, the REST API reads them back — from a backend service, a CI job, an incident bot, or an AI agent. It’s the right tool when you want to:
  • Pull the full JSON of a trace (and its complete event timeline) into another system — e.g. to attach to an investigation ticket.
  • List or count traces matching a filter (status, severity, tag, attribute) over a time window.
  • Let an AI agent explore your traces with a server key and a typed contract.
The REST API is read-only. To create traces and emit events, use the Web SDK or Node.js SDK. The two use different keys — see Authentication.

​
Base URL

All data endpoints live under /v1/* and require a server API key. Responses are always scoped to the single project that key belongs to.

​
Self-serve references

The API ships its own machine- and agent-readable docs. Point people at the Swagger UI and point AI agents at llms.txt — both are always current with the deployed API.

Swagger UI

Interactive, try-it-in-the-browser docs for every endpoint. Best starting point for a human exploring the API.

llms.txt

A single plain-text brief written for LLMs — endpoints, filter syntax, response shapes, and worked examples. Paste it into an agent’s context.

OpenAPI (YAML)

The full machine-readable contract. Feed it to a code generator or API client.

OpenAPI (JSON)

The same contract in JSON, for tooling that prefers it.
Wiring up an AI agent or assistant? Give it the contents of https://api.mirador.org/llms.txt plus a server key. That single file documents the auth scheme, the filter grammar, pagination, every response shape, and the event-payload model — enough for an agent to query Mirador with no other context.

​
What you can call

See Endpoints for parameters, filter syntax, and response shapes.

​
A first request

​
Next Steps

Authentication

Create a server key and authenticate your requests

Endpoints

Every endpoint, filter, and response shape

Exporting traces

Pull a full trace + events into tickets and other systems