# SAIR Competition Public API

Use the SAIR Competition Public API for competition automation: CLIs, scripts, CI pipelines, and training jobs.

## What's covered

- **[Account](./endpoints/account.md)** — confirm a key and its owner.
- **[Competitions](./endpoints/competitions.md)** — metadata, eligibility, leaderboards, submissions, and per-competition API guides.
- **[Playground](./endpoints/playground.md)** — per-competition practice runs: models, problem sets, results, SSE event stream, usage.
- **[Cheatsheets](./endpoints/cheatsheets.md)** — your private Playground cheatsheet library.
- **[Solver templates](./endpoints/solver-templates.md)** — your private Playground Lean 4 solver and custom problem library.
- **[Contributor Network](./endpoints/contributor-network.md)** — browse, publish, favorite, comment on, and view lineage for shared cheatsheets, solver templates, and model references. Benchmark data is available for platform-benchmarked items.

## Where to start

1. **[Authentication](./authentication.md)** — authenticate with an API key and choose scopes.
2. **[Quick start](./guides/quick-start.md)** — from an API key to a first submission with `curl`.
3. **[Conventions](./conventions.md)** — envelope, status codes, methods, naming.

## Reference

- [Errors](./errors.md)
- [Pagination](./pagination.md)
- [Rate limiting](./rate-limiting.md)
- [Submission spec](./reference/submission-spec.md)
- [Submission kinds and DTOs](./reference/submission-kinds.md)

## Working examples

- **`examples/python/`** — client plus end-to-end scripts.
- **`examples/typescript/`** — same flows in TypeScript.

The clients are meant to be copied into your own codebase rather than installed as a dependency.