# Pulseforge Events

> Incident communication API, browser SDK, and status widgets.

- Documentation: https://pr-1-801e0a17d1af.thally.app
- GitHub: https://github.com/thallylabs/pulseforge-docs
- Full docs for LLMs: https://pr-1-801e0a17d1af.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pr-1-801e0a17d1af.thally.app/ai.txt
- Structured docs index (JSON): https://pr-1-801e0a17d1af.thally.app/api/docs-index
- OpenAPI spec: https://pr-1-801e0a17d1af.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-1-801e0a17d1af.thally.app/api/docs/{page-id}
- Search API: https://pr-1-801e0a17d1af.thally.app/api/search?q={query}
- Capability manifest (skill): https://pr-1-801e0a17d1af.thally.app/skill.md
- Agent guidance (editing these docs): https://pr-1-801e0a17d1af.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pr-1-801e0a17d1af.thally.app/api/mcp
- Agent readiness: https://pr-1-801e0a17d1af.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

### Pulseforge Events

- [Pulseforge Events](https://pr-1-801e0a17d1af.thally.app/): Publish service status, manage incident timelines, and embed current availability.
- [Open your first incident](https://pr-1-801e0a17d1af.thally.app/quickstart): Install the Pulseforge SDK, create an incident, and verify public status.

### Client surfaces

- [Deploy the HTTP server](https://pr-1-801e0a17d1af.thally.app/http-server): Set up the Pulseforge HTTP server to serve the status API and handle incident mutations.
- [Server-side setup](https://pr-1-801e0a17d1af.thally.app/server-setup): Create and manage incident state using the Pulseforge store.
- [Browser SDK](https://pr-1-801e0a17d1af.thally.app/components): Call Pulseforge through a typed client in browser or server JavaScript.
- [Widget](https://pr-1-801e0a17d1af.thally.app/customization): Embed current Pulseforge service status with one custom element.
- [Alert rules](https://pr-1-801e0a17d1af.thally.app/alert-rules): Route incident events to email or webhook destinations with reusable alert rules.

## API Reference

Interactive API reference available at https://pr-1-801e0a17d1af.thally.app/api