Public API

A public JSON API serves the content of avi.run, so agents and scripts can read Avi's documentation, pricing and trust details without scraping HTML.

Base URL: https://avi.run/api/v1
Authentication: none. The API is public and read-only (GET, HEAD, OPTIONS).
CORS: Access-Control-Allow-Origin: *
OpenAPI 3.1 description: https://avi.run/openapi.json
RFC 9727 API catalog: https://avi.run/.well-known/api-catalog

Method	Path	operationId	Returns
GET	`/api/v1`	`getApiIndex`	Describe the Avi site API and list its operations.
GET	`/api/v1/docs`	`listDocs`	List every Avi documentation page.
GET	`/api/v1/docs/{slug}`	`getDoc`	Get one Avi documentation page, including its Markdown.
GET	`/api/v1/pricing`	`getPricing`	Get Avi's plan, prices, credits and pricing FAQ.
GET	`/api/v1/trust`	`getTrust`	Get Avi's certifications, AI data handling, safeguards and subprocessors.

bash

curl https://avi.run/api/v1/docs
curl https://avi.run/api/v1/docs/getting-started
curl https://avi.run/api/v1/pricing
curl https://avi.run/api/v1/trust

Every operation has a unique operationId, a description, typed parameters and typed response schemas in the OpenAPI document, so it converts directly into function-calling tool definitions.

Errors

Every API error is an RFC 9457 problem document (Content-Type: application/problem+json) with a stable code, a human-readable detail, and a resolution that says how to fix the request:

json

{
  "type": "https://avi.run/docs/api#doc-not-found",
  "title": "Documentation page not found",
  "status": 404,
  "detail": "No Avi documentation page has the slug \"nope\".",
  "instance": "/api/v1/docs/nope",
  "code": "doc_not_found",
  "resolution": "List valid slugs with GET /api/v1/docs, then request GET /api/v1/docs/{slug}.",
  "documentation_url": "https://avi.run/docs/api#errors"
}

api-route-not-found

HTTP 404 — API route not found. List the available operations at /openapi.json or /.well-known/api-catalog, or start from GET /api/v1.

doc-not-found

HTTP 404 — Documentation page not found. List valid slugs with GET /api/v1/docs, then request GET /api/v1/docs/{slug}.

method-not-allowed

HTTP 405 — Method not allowed. The Avi site API is read-only. Use GET (or HEAD) as described in /openapi.json.

Versioning

Stable operations live under /api/v1. A breaking change ships under a new major path (/api/v2); /api/v1 keeps working unchanged.

Markdown for AI agents

Every page on avi.run has a Markdown representation. Request any page with Accept: text/markdown, or append .md to its path (/index.md for the home page). Responses carry Vary: Accept. Paths that don't exist return HTTP 404 with a Markdown body when Markdown is requested.

llms.txt — an index of the site for language models, with when-to-use guidance.
llms-full.txt — the complete documentation in one Markdown file.

Help

Questions about the API: support@avi.run.