Skip to main content

Documentation for AI agents

Every page of this documentation is available in a machine-readable form. If you build an AI agent, a retrieval pipeline, or an internal assistant that answers questions about MONEI, use these endpoints instead of scraping the rendered HTML.

What is available

ResourceURLFormat
Page indexhttps://docs.monei.com/llms.txtMarkdown
Any page as Markdownhttps://docs.monei.com/<path>.mdMarkdown
Markdown negotiationAccept: text/markdown on any page URLMarkdown
MCP serverSee MCP serverMCP
Search APIhttps://docs-search.monei.comJSON
Canonical URL listhttps://docs.monei.com/sitemap.xmlXML
REST API spechttps://js.monei.com/api/v1/openapi.jsonOpenAPI 3
GraphQL schemahttps://graphql.monei.com/GraphQL (introspection)
Postman collectionhttps://postman.monei.com/Postman

Read any page as Markdown

Drop the trailing slash from a documentation URL and append .md. You get the page content without navigation, scripts, or layout markup:

curl https://docs.monei.com/payments/refunds.md

Spanish pages work the same way under the /es/ prefix:

curl https://docs.monei.com/es/payments/refunds.md

https://docs.monei.com/llms.txt lists every page with its title, description, and Markdown URL, grouped by section. Start there when you want to walk the whole corpus.

You can also ask for it by content negotiation, without changing the URL. Send Accept: text/markdown to any documentation URL and you get that page's Markdown; the response carries Vary: Accept:

curl -H "Accept: text/markdown" https://docs.monei.com/payments/refunds/
tip

The .md URL and the Accept header are equivalent — use whichever your client makes easier. Anything already carrying an extension, such as /llms.txt or /sitemap.xml, is served as-is either way.

MCP server

The documentation index is published as a hosted Model Context Protocol server. Point an MCP client at this URL — there is no key to obtain, no account to create, and nothing to install:

https://docs-mcp.monei.com/mcp

Add it to your client

claude mcp add --transport http monei-docs https://docs-mcp.monei.com/mcp

Check it registered with claude mcp list.

Once connected, ask your agent something the docs answer — "how do I refund a payment with MONEI?" or "which payment methods support pre-authorization?" — and it will search these pages instead of guessing.

It exposes two tools:

ToolWhat it does
algolia_search_index_moneiSearch the documentation. Same index as the site's search.
algolia_search_for_facet_valuesList the values of a facet, such as lang or record_type.

Results are the same DocSearch records described under Response shape, so each hit carries the section anchor to cite and a url whose Markdown twin you can fetch (drop the #anchor and the trailing slash, then append .md).

info

The server is read-only — it can search the documentation and nothing else. It reaches no MONEI account, payment, or customer data.

The documentation index is served by Algolia DocSearch. Query it over HTTP with no credentials — the search key is attached for you at the edge:

ParameterValue
Endpointhttps://docs-search.monei.com
Index namemonei

The request and response format is Algolia's, so any Algolia client works if you point it at this host.

curl -G "https://docs-search.monei.com/1/indexes/monei" \
--data-urlencode "query=refund a payment" \
--data-urlencode "filters=lang:en AND record_type:docs" \
--data-urlencode "hitsPerPage=5" \
--data-urlencode "attributesToRetrieve=url,hierarchy,content"

Filters

Combine these attributes in the filters parameter to narrow a query:

AttributeValuesUse it to
langen, esReturn one language instead of both.
record_typedocs, apiSeparate guides from generated API reference.
typecontent, lvl1lvl6Prefer body text over heading-only records.

Response shape

Each hit is a DocSearch record: a section of a page, not a whole page.

  • url — the canonical URL, with the anchor of the matching section. To fetch the Markdown, drop the #anchor first, then the trailing slash, then append .md: /payments/refunds/#timing becomes /payments/refunds.md. Appending .md to the whole URL yields #timing.md, which is just a fragment and still requests the HTML page.
  • hierarchy.lvl0lvl6 — the heading path, from the section down to the matched heading.
  • content — the body text of the section, or null when the record is a heading.

Because every hit carries a section anchor, cite the exact section (/payments/refunds/#timing) rather than pointing a reader at the whole page.

warning

Search is read-only and shared by everyone using these docs. Cache what you retrieve, and do not use search to mirror the corpus — llms.txt and the .md URLs exist for bulk reading.

API specifications

  • OpenAPIhttps://js.monei.com/api/v1/openapi.json describes every REST endpoint, request body, and response schema. It is the source for the REST API reference.
  • GraphQLhttps://graphql.monei.com/ accepts standard introspection queries. See the GraphQL API reference and MONEI Connect for who it is for.
  • Postmanhttps://postman.monei.com/ is a prebuilt collection for trying the REST API.

To call either API you need an API key from your MONEI Dashboard. Use a test key while you build — see Test and go live.

Crawling

https://docs.monei.com/robots.txt allows every crawler, including GPTBot, ClaudeBot, Google-Extended, PerplexityBot, and Amazonbot. Nonexistent paths return a real HTTP 404, so you can trust a 404 to mean the page does not exist.

Common questions

Should I use the MCP server or the search API?

Use the MCP server if your client speaks MCP — it needs no credentials and no code. Use the search API when you are writing your own retrieval pipeline and want direct control over filters and pagination. Both query the same index.

Do I need an API key to search?

No. docs-search.monei.com attaches a search-only key at the edge, so your client sends nothing. It queries the documentation index and nothing else — it grants no access to your MONEI account.

Which URL should an agent cite?

Cite the HTML URL, including the section anchor — it is the canonical address a human can open. To read that page as Markdown, strip the anchor and the trailing slash first, then append .md.