AI-Friendly Resources
Building with Beam and using an AI assistant like Claude, ChatGPT, Cursor, or Gemini? You can let it read these docs directly, so its answers match how Beam’s API actually works — no copy-pasting pages into every prompt.
We publish the docs in two forms an AI can read:
https://docs.beamcheckout.com/llms.txt— one list of every page in these docs, with a link and a one-line summary for each.https://docs.beamcheckout.com/<page>.md— the plain-text (Markdown) version of any single page, e.g.
Quickest way: paste the link into your chatbot
Copy this link, paste it into your AI chatbot, then add what you want to do. Most chatbots open the link and read it on their own — no upload needed.
https://docs.beamcheckout.com/llms.txt
Use this as context for Beam's API docs. I want to integrate Beam Payment Links
into my Node.js app — show me how to create a payment link and verify the
webhook signature.The chatbot reads the list, opens only the pages it needs, and answers from the real docs.
Tool-by-tool setup
The URL to use everywhere: https://docs.beamcheckout.com/llms.txt
| Tool | How to add it |
|---|---|
| Claude (claude.ai / Claude Code) | Paste the URL in a prompt, or add it as a Project Knowledge source. |
| Cursor | Settings → Features → Docs → add as a custom doc, then @-mention it in chat. |
| ChatGPT | Paste the URL in a chat, or add it as a Project file or custom instruction. |
| Gemini | Paste the URL, or attach the file, in a chat. |
| RAG / MCP servers | Fetch and index it like any other source. Each line is a [title](url): description entry. |
What’s in llms.txt
llms.txt follows the open llms.txt standard . It lists every doc page, grouped by topic, with a one-line description and a link:
- [Authentication](https://docs.beamcheckout.com/get-started/authentication.md): Basic Auth with merchantId/apiKey.Each link points to the page’s .md version (below), so a tool reads the list first, then opens only the pages it needs.
curl https://docs.beamcheckout.com/llms.txtReading a single page as Markdown
Want just one page instead of the whole list? Add .md to the end of its URL. You get the plain Markdown source instead of the rendered web page — easier to feed into an LLM, a RAG pipeline, or a docs crawler.
curl https://docs.beamcheckout.com/response-codes.md
curl https://docs.beamcheckout.com/payment-links/payment-links.md