# Using these docs with AI tools

Every guide here is also available as plain Markdown, so you can give it to an AI assistant or a coding agent without copying from the page. Give the tool the version you integrate with: these files describe Core API v2.

To let an assistant read your own ODUS data, such as payments and orders, connect it to the ODUS MCP server instead. See [Connect an AI assistant to ODUS](https://docs.odus.com/docs/guides/ai-connector/.md).

## Give a tool the whole documentation

| File                                                   | Contains                                                                       | Use it when                                                          |
| ------------------------------------------------------ | ------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
| [`llms.txt`](https://docs.odus.com/llms.txt)           | A list of every guide, each with a link to its Markdown and a one-line summary | The tool can fetch links, and should read only the pages it needs    |
| [`llms-full.txt`](https://docs.odus.com/llms-full.txt) | Every guide in one file                                                        | The tool cannot follow links, or you want to load everything at once |

Both cover the Core API v2 guides only. The API reference has its own Markdown, described in [Give a tool the API contract](#give-a-tool-the-api-contract).

## Give a tool one page

Each guide page and each Core API v2 and OMS API reference page has two buttons next to its breadcrumbs:

* **Copy for LLM** copies the page as Markdown, ready to paste into a chat.
* **View as Markdown** opens the page as plain text.

You can also add `.md` to the end of any of those URLs:

```
https://docs.odus.com/docs/guides/payments/making-payments.md
```

## Give a tool the API contract

Two forms of the API reference are written for tools rather than browsers:

* **The reference as Markdown.** [The Core API v2 index](https://docs.odus.com/docs/api/core/v2/odus-core-api.md) lists every endpoint and webhook event. Each entry links to a page with its parameters, request body and responses. The OMS API has [its own index](https://docs.odus.com/docs/api/oms/odus-oms-api.md).
* **The OpenAPI document**, below. A tool that generates code or validates requests should read this.

Both describe every Core API v2 endpoint, every request and response field, and the body of every webhook event. When a guide and the reference differ on a field name or type, the reference is correct.

| Environment | OpenAPI document                               |
| ----------- | ---------------------------------------------- |
| Production  | `https://api.odus.com/openapi.v2.json`         |
| Sandbox     | `https://sandbox-api.odus.com/openapi.v2.json` |

The document is OpenAPI 3.1. You can also generate a typed client and webhook types from it. See [Upgrading from v1 to v2](https://docs.odus.com/docs/guides/upgrading/v1-to-v2.md#if-you-generate-code-from-the-openapi-document) for what to check in your generator.

## Point your coding agent at the docs

Most coding assistants can read documentation from a URL, or follow an instructions file in your repository. To make every session start from the right version, add a line like this to your project's `AGENTS.md`, or to the equivalent file your assistant reads:

```
ODUS: read https://docs.odus.com/llms.txt for the guides and

https://api.odus.com/openapi.v2.json for the API contract. Use Core API v2:

every path starts with /v2.
```

Check the version in what it writes

AI models are trained on older copies of the web, so a tool may know only Core API v1 or the API's former name, the Orchestration API. Code it writes from memory can call unprefixed or `/v1` routes, which stop working at 00:00 UTC on 4 November 2026. Give it the files above rather than relying on what it already knows, and check that every Core API path in its output starts with `/v2`.
