---
title: "The reference, as markdown for agents"
method: GET
path: "/llms.txt"
tags: ["docs"]
---

# The reference, as markdown for agents

`GET /llms.txt`

## Request

- Base URL: `https://api.tradingpal.io/api/v1`
- URL: `https://api.tradingpal.io/api/v1/llms.txt`
- Auth: one of:
  - none
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.tradingpal.io/oauth/authorize`, token URL `https://api.tradingpal.io/oauth/token`, scopes: `patterns`)

Returns the agent reference as text/markdown with the production URLs filled in. It is the prose contract: the rules for agents, the routes, the envelope, the Setup and StatBlock shapes and the error codes. The same file is served at /llms.txt on the API host. No key is needed; cached for an hour.

## Response `200`

text/markdown

## Other responses

- `429`: rate_limited; wait details.retry_after_seconds

---

[API](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api.md) · [All operations](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api/revisions/e96e1f20c1ce?raw)