# OrbitRail Product Docs

> API and SDK documentation for OrbitRail Events and OrbitRail Verify.

- Documentation: https://pr-2-f831df687d6c.thally.app
- GitHub: https://github.com/thallylabs/orbitrail-product-docs
- Full docs for LLMs: https://pr-2-f831df687d6c.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pr-2-f831df687d6c.thally.app/ai.txt
- Structured docs index (JSON): https://pr-2-f831df687d6c.thally.app/api/docs-index
- OpenAPI spec: https://pr-2-f831df687d6c.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://pr-2-f831df687d6c.thally.app/api/docs/{page-id}
- Search API: https://pr-2-f831df687d6c.thally.app/api/search?q={query}
- Capability manifest (skill): https://pr-2-f831df687d6c.thally.app/skill.md
- Agent guidance (editing these docs): https://pr-2-f831df687d6c.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pr-2-f831df687d6c.thally.app/api/mcp
- Agent readiness: https://pr-2-f831df687d6c.thally.app/api/agent-readiness

### Recommended workflow

1. Use this index, the search API, or `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Get started

### Overview

- [OrbitRail documentation](https://pr-2-f831df687d6c.thally.app/): Build reliable event workflows with OrbitRail Events and verify every payload with OrbitRail Verify.
- [Quickstart](https://pr-2-f831df687d6c.thally.app/quickstart): Publish one OrbitRail event and configure the Verify SDK to validate its signed payload.

## Events

### OrbitRail Events

- [Events overview](https://pr-2-f831df687d6c.thally.app/events/overview): Understand the OrbitRail Events ingestion, authentication, retry, and retention contract.
- [Retries and replay](https://pr-2-f831df687d6c.thally.app/events/retries): Plan for OrbitRail's 24-hour automatic retry window and seven-day event retention period.

## Verify

### OrbitRail Verify

- [Verify SDK quickstart](https://pr-2-f831df687d6c.thally.app/verify/quickstart): Install OrbitRail Verify and validate a signed payload in a Node.js application.
- [Configuration](https://pr-2-f831df687d6c.thally.app/verify/configuration): Configure OrbitRail Verify with an API key, flush limit, algorithm, and clock tolerance.

## API Reference

Interactive API reference available at https://pr-2-f831df687d6c.thally.app/api