For AI agents

If you are building an agent, or pointing one at Filemonk, start with these. They are public (no API key) and generated from the same registry the API runs on, so they cannot drift from what the API accepts.

Document	URL	What it is
skill.md	/api/v2/external/skill.md	The agent skill: how to authenticate, discover actions and call them safely, with the full action table, recipes, errors and rate limits.
llms.txt	/api/v2/external/llms.txt	A short orientation for language models: what Filemonk is, the guardrails, and links to the rest. Also at https://app.filemonk.io/llms.txt.
llms-full.txt	/api/v2/external/llms-full.txt	llms.txt followed by the whole skill, for agents that read one file.
OpenAPI 3.1	/api/v2/external/openapi.json	Every action with parameters, request and response examples and error responses.
MCP manifest	/api/v2/external/mcp.json	The connector manifest for the MCP server.
Action manifest	GET /api/v2/external/help	Every action with its aliases and request schema. Needs the API key; ?prefix=/orders narrows it to one resource.

All hosted at https://app.filemonk.io.

How an agent should use Filemonk

1. Connect over MCP at https://app.filemonk.io/api/v2/external/mcp rather than asking for the API key. The merchant approves the connection once. See AI connectors (MCP).
2. Read skill.md. It lists every action and the conventions that apply to all of them.
3. Find the action by what the merchant asked: each action has plain-English aliases such as “resend download email” or “why didn’t my customer get their file”, and the MCP search tool ranks them for you.
4. Read before you write. Fetch the order, product or setting first, and tell the merchant what will change.
5. Preview, then confirm. Destructive actions answer 409 until you repeat them with confirm: true. Pass the message on to the merchant and wait for a yes. See Previews and confirm.
6. Respect the budget. 40 points per minute per key. Prefer one list call with per_page to many single reads, and wait retry_after seconds on a 429.

Guardrails

• Never ask a merchant to paste an API key into a chat.
• Sends are real: send_email, send_emails, notify_buyers and test_email email buyers or the merchant, and fulfil fulfils the order in Shopify.
• Deletes of files, digital products, licence keys and licence tags are permanent. A deleted order only comes back by importing it again.

Other docs for models

Each page of this site has a Markdown copy: add .md to the page URL without the trailing slash. The site’s own index for models is at /llms.txt.

Merchant guides (how to use the Filemonk app, not the API) are at help.filemonk.io, with their own llms.txt.