Use Froomle documentation with AI

View Markdown

Each page of the current Froomle documentation is also available as Markdown, so you can read or share it with an AI assistant. The documentation home and every other supported page have a View Markdown link and a Copy page action.

Find the right content

Start with the documentation index. It highlights common tasks and links to smaller section indexes, which list the Markdown version of each current public page and an HTML alternative. The Markdown page links back to its canonical HTML page, where you can check the latest guidance and follow related links.

For one question, open the relevant documentation page and use Copy page to paste its Markdown into your assistant. If your assistant can fetch and follow web links, you can share the index and ask it to open the relevant linked pages. The index is navigation, not the answer itself; some chat assistants cannot fetch it or follow its links. For chat assistants, direct HTML page links may work when the index or Markdown links do not. If those links fail too, paste the page content instead.

For example, you could ask:

Read https://docs.froomle.com/froomle-doc-main/v2/guide/topics/tracking-events.html
and https://docs.froomle.com/froomle-doc-main/v2/api_reference/events/events_api.html.
Explain which recommendation-click fields are explicitly required, optional,
or only shown in an example. Link the pages you actually read. If you cannot
open them, or the docs do not specify something, say so.

Check the answer

Ask the assistant to cite the documentation pages it used. Open those pages to verify API fields, SDK methods, consent requirements, and code examples before implementing them. An assistant may use old information or invent a detail that is not in the docs. For exact request and response contracts, use the API reference.

The Markdown pages and index contain public documentation only. Do not paste Froomle credentials, access tokens, or private customer data into an external AI tool unless your organization has approved it for that data.