LLM Access to Documentation

This documentation is designed to be consumed programmatically by Large Language Models (LLMs) and AI agents. Raw markdown versions of all pages are available through dedicated endpoints.

Endpoints

EndpointDescription
GET /docs/md/sitemapIndex of all documentation pages
GET /docs/md/{path}Raw markdown for a specific page

Both endpoints return text/markdown content type.

Getting Started

Step 1: Fetch the Sitemap

Start by fetching the documentation sitemap to discover all available pages:

curl https://your-app.finopsbricks.com/docs/md/sitemap

Step 2: Fetch Individual Pages

Use the path from the sitemap to fetch specific documentation:

# Get authentication docs
curl https://your-app.finopsbricks.com/docs/md/api/authentication

# Get error handling docs
curl https://your-app.finopsbricks.com/docs/md/api/errors

URL Pattern

Documentation paths follow this pattern:

/docs/md/{section}/{subsection}/{page}

Integration Example

async function loadDocs() {
  const base = 'https://your-app.finopsbricks.com/docs/md';

  const auth = await fetch(`${base}/api/authentication`).then(r => r.text());
  const errors = await fetch(`${base}/api/errors`).then(r => r.text());

  return { auth, errors };
}