Documentation hub

Docs for humans and agents.

A stable discovery page for agents, crawlers, and developers looking for SuperAda API documentation, machine-readable metadata, public datasets, and support routes.

OpenAPI spec llms.txt

Policy

Versioning and deprecation

Canonical /api/v1/... routes, version and deprecation headers, Sunset dates, and how much notice removals get.

Open OpenAPI

Machine-readable API spec

OpenAPI 3.1 specification for public SuperAda API endpoints, response headers, structured errors, and version metadata.

Open llms.txt

Agent orientation file

Plain-text guidance for language models and agents: what the site is, which links matter, and how to find public data.

Open Resources

Resource atlas

Human-readable guides, tools, studies, benchmarks, and workflow references built by the SuperAda crew.

Open Sitemap

Crawl map

Search-engine and crawler-friendly sitemap index for public SuperAda pages.

Open Contact

Support and corrections

Where to report API documentation issues, public-data problems, or inaccurate site information.

Open

For agents

Agent quickstart

Five steps from first contact to a well-behaved integration.

01
Orient
Read /llms.txt for site orientation.
02
Learn
Read the versioning and deprecation policy below.
03
Integrate
Use /openapi.json for endpoint schemas and response headers.
04
Version
Prefer canonical versioned API routes under /api/v1/....
05
Behave
Respect RateLimit-*, Retry-After, API-Version, Deprecation, and future Sunset headers.

Policy

REST versioning and deprecation policy

The current public API is version 1. Agents should integrate against the canonical versioned paths under /api/v1/..., such as /api/v1/benchmarks and /api/v1/subscribe. The older unprefixed /api/... paths remain compatibility aliases for v1.

Breaking API changes will ship in a new major versioned namespace, for example /api/v2/subscribe. Non-breaking additions, such as optional response fields or new static benchmark datasets, may be added to v1 without changing existing fields.

Active v1 responses include API-Version: 1, X-API-Version: 1, and Deprecation: false. If an endpoint becomes deprecated, SuperAda will change that signal to Deprecation: true, include a Sunset header with the planned retirement date, keep a policy Link header, and list the replacement path on this page.

90 daysSuperAda aims to provide at least 90 days of notice before removing a public API endpoint unless security, abuse, or legal requirements force a faster shutdown.

API-Version: 1
X-API-Version: 1
Deprecation: false
Link: <https://superada.ai/docs/#versioning-policy>; rel="deprecation"; type="text/html"

# Future deprecated endpoint example:
Deprecation: true
Sunset: Wed, 31 Dec 2027 23:59:59 GMT