API and machine-readable files

Where to find the varsafe OpenAPI specification, the REST API reference, llms.txt, and the MCP manifest — for API clients, code generators, and AI agents.

CLI v7.4.0

varsafe publishes its public surface in formats a program can read directly. Point a client generator, an HTTP client, or an AI agent at these instead of scraping the docs.

REST API

What	Where
API base URL	`https://api.varsafe.dev`
OpenAPI 3.1 specification	varsafe.dev/openapi.json, also served by the API at api.varsafe.dev/openapi.json
Rendered API reference	API reference — one page per operation, with curl, JavaScript and Python samples

Present a credential as Authorization: Bearer <token> — usually an API token. Which credentials a route accepts is not uniform, so read each operation’s security field; operations that also accept a CLI credential list the scopes it needs under x-varsafe-cli-scopes.

Every operation’s success and error bodies are described by JSON Schemas under components.schemas, so a generated client gets typed results. Objects list the properties sent today; ignore any you do not recognise, because a later release may add one.

Errors return { "statusCode", "code", "message" }. Branch on code; message is for humans and may change. The MCP endpoint’s authentication errors use the OAuth shape { "statusCode", "error", "error_description" } instead.

Files for AI agents

File	Contents
varsafe.dev/llms.txt	What varsafe is, when to use it, and links to every interface below
docs.varsafe.dev/llms.txt	An index of every documentation page, including the API reference
docs.varsafe.dev/llms-full.txt	The full documentation as a single Markdown file
varsafe.dev/.well-known/mcp.json	Where the MCP endpoint lives and how to authorize against it

Any documentation page is also available as Markdown: append .md to its URL, for example /getting-started.md.

To give an agent scoped, audited access to secrets rather than documentation, connect it over MCP — see the MCP guide.