Machine-Readable Docs

Machine-Readable Docs

These endpoints serve the API specification in formats optimized for automated tooling, LLM agents, and code generators.

OpenAPI specification

GET https://api.brandmappr.com/api/openapi.yaml

OpenAPI 3.1 specification covering the /api/v1/location-map endpoint, all parameters, response schemas, and error codes. Use with Swagger UI, Postman, or any OpenAPI-compatible tool.

Agent docs

GET https://api.brandmappr.com/api/agent-docs

Flat markdown document optimized for LLM agents. Contains the full API reference in a single file with no navigation or HTML. Designed to fit within a single context window for AI coding assistants.

LLM discovery file

GET https://api.brandmappr.com/llms.txt

Standard llms.txt discovery file following the llms.txt specification (opens in a new tab). Allows LLM-powered tools to discover and understand the BrandMappr API automatically.

Usage with AI tools

These machine-readable formats are useful when:

  • Building custom GPTs or Claude Projects that call the BrandMappr API
  • Generating client SDKs from the OpenAPI spec
  • Training AI agents to use the API without manual documentation reading
  • Integrating with tools like Cursor, Copilot, or Claude Code that can read API specs
MCP Server