LLM-friendly docs
Use our LLM-friendly documentation to help AI coding assistants integrate with Dojo APIs.
If you're using an AI coding assistant like GitHub Copilot, Claude Code, Codex, or similar tools, you can point them to our LLM-optimized documentation for faster, more accurate integration help.
Available files
| File | URL | Description |
|---|---|---|
| llms.txt | /llms.txt | Index of all documentation with links — start here |
| llms-full.txt | /llms-full.txt | All documentation in a single file |
By integration type
| File | URL | Description |
|---|---|---|
| llms-online.txt | /llms-online.txt | Online payments — checkout, Components, payment links, and virtual terminal |
| llms-payment-intents.txt | /llms-payment-intents.txt | Payment intents, setup intents, captures, refunds, cancellations, and webhooks |
| llms-inperson-pac.txt | /llms-inperson-pac.txt | Pay at Counter terminal sessions, captures, refunds, and pre-authorisation |
| llms-inperson-pat.txt | /llms-inperson-pat.txt | Pay at Table — searching payable orders, locking/unlocking, recording payments, and printable bills |
| llms-epos.txt | /llms-epos.txt | EPOS capability registration, event contracts, and EPOS Data API integration |
| llms-core-concepts.txt | /llms-core-concepts.txt | Shared orders, parties, reservations, tables, areas, terminal sessions, and event vocabulary |
| llms-order-and-pay.txt | /llms-order-and-pay.txt | Self-service ordering and payment flows coordinated with POS capabilities |
| llms-plugins.txt | /llms-plugins.txt | WooCommerce, Magento, OpenCart, and PrestaShop plugin setup and troubleshooting |
| llms-bookings.txt | /llms-bookings.txt | Dojo Bookings / RMS reservations, parties, tables, and POS synchronization |
| llms-mobile-ios.txt | /llms-mobile-ios.txt | iOS SDK |
| llms-mobile-android.txt | /llms-mobile-android.txt | Android SDK |
| llms-mobile-reactnative.txt | /llms-mobile-reactnative.txt | React Native SDK |
| llms-mobile-ttpoi.txt | /llms-mobile-ttpoi.txt | Tap to Pay on iPhone |
OpenAPI specifications
For precise API integration, agents can fetch the machine-readable OpenAPI specs directly:
- Dojo API (latest): /api/v3/bundled.json
- Transactions API: /transactions/bundled.json
- EPOS Data API (REST): /epos-data/bundled.json
- EPOS Data API (WebSocket): /epos-data-asyncapi/bundled.yaml
- PCI API: /pci-api/bundled.json
How to use
GitHub Copilot (Copilot Chat / Copilot Coding Agent)
Copy the relevant file URL from the tables above into a prompt like:
Fetch the llms-full.txt URL above and use it to help me integrate Dojo payments into my app.
Claude Code
Use the /fetch command or point Claude to the file you need:
Fetch the llms-payment-intents.txt URL above and help me create a payment intent using the Dojo API.
OpenAI Codex / ChatGPT
Paste the relevant file URL or its content into your prompt:
Using the llms.txt URL above, help me set up webhooks for payment notifications.
For focused tasks, prefer the narrowest product-specific file, such as llms-online.txt, llms-payment-intents.txt, llms-epos.txt, llms-plugins.txt, or the relevant mobile SDK file, instead of the full documentation.
What's included
These files follow the llmstxt.org standard and are automatically generated from our documentation. They include:
- All human-written guides and tutorials
- Links to OpenAPI specifications for all Dojo APIs
- Authentication details and API base URLs
- Code examples and step-by-step integration guides
The files are regenerated with every documentation update, so they're always in sync with the latest docs.