API Reference

Apira keeps exact endpoint schemas in generated OpenAPI, not in hand-written guide pages.

Canonical sources

Use these sources when you need the current request and response contract:

• Interactive API reference: Scalar UI for exploring endpoints.
• OpenAPI JSON: machine-readable OpenAPI 3.1 schema.
• /llms.txt: plain-text API guide for AI agents.

The Vocs docs explain how to use Apira. The OpenAPI document is the source of truth for exact endpoint field names, validation rules, and documented response schemas. Operational/global errors are summarized in these docs when they are not endpoint-specific.

Primary search endpoint

The main public search endpoint is:

POST /v1/github/search

Authenticated requests use the X-API-Key header. For coding-agent setup, see Apira for Coding Agents. For companion skill/workflow templates, see Follow-on Skills.

Avoid schema drift

When building clients, agents, or tests, fetch the OpenAPI document instead of copying endpoint schemas from these narrative docs.