Documentation for AI agents
This documentation is built for both people and AI agents to read. All content is generated as static HTML and plain Markdown.
Which format to use
Section titled “Which format to use”| Format | Use it when… |
|---|---|
Per-page Markdown — e.g. /en/guides/partner-api-guide.md |
You want to feed a single page to an LLM, or paste it into a chat without HTML noise. |
/llms.txt |
You want the agent to first discover what the site contains and then decide what to read. This is the index, following the llmstxt.org standard. |
/llms-full.txt |
You want to load every guide in full, in one shot. |
/llms-small.txt |
Same, but a trimmed-down version for models with a small context window. |
| OpenAPI 3.0 | Your tool understands OpenAPI: it’s the source of truth for the API reference (endpoints, schemas, authentication). There are two specs — Partner API and Purchase Code API — also available in Spanish. |
Per-page Markdown
Section titled “Per-page Markdown”Every guide page is also published as plain Markdown: add .md to its path.
https://docs.firma.digital/en/guides/partner-api-guide.mdhttps://docs.firma.digital/guides/partner-api-guide.mdEvery guide also has buttons at the top to copy the Markdown to your clipboard, view it raw, or open that page directly in ChatGPT, Claude, or Gemini with the context already loaded.
Pointing an agent at this documentation
Section titled “Pointing an agent at this documentation”For an assistant with internet access, the recommended entry point is llms.txt:
Read https://docs.firma.digital/llms.txt and then whatever documents youneed from there to help me integrate Firma Digital's partner API.If it’s going to generate code against the API, give it the OpenAPI spec directly:
Use https://docs.firma.digital/openapi/partner-api-en.json as the referencefor Firma Digital's Partner API and help me implement the redeem flow.Authentication
Section titled “Authentication”Any code an agent generates needs to authenticate. Every request to both APIs carries the API Key in the x-gw header:
x-gw: {YOUR_API_KEY}Content-Type: application/jsonThe full flow is in the Partner API Integration Guide.