This page View Markdown Open in ChatGPT Open in Claude

API Maker docs for AI assistants¶

API Maker is built for the AI era, and so is this documentation. Every page is available as plain Markdown, the whole site fits in one text file, and an assistant working in your project folder finds the code and the security report of your account as files.

Files an assistant can read¶

What	URL	Use it for
Index of the documentation	`https://docs.apimaker.dev/llms.txt`	One page per line with its title, description and Markdown URL, grouped like the navigation. Give it to an agent so it fetches only the pages it needs.
The whole documentation	`https://docs.apimaker.dev/llms-full.txt`	Every page in one text file, in reading order. Paste it in a project knowledge base or a long context.
Any page as Markdown	the page URL with `.md` instead of `.html`, for example `/v1/docs/schema/schema.md`	Clean text without navigation, with the snippets resolved and the diagrams replaced by their caption.
The website for AI	`https://apimaker.dev/llms.txt` and `llms-full.txt`	The feature pages and the deployment architectures.

Every page also carries <link rel="alternate" type="text/markdown"> pointing at its Markdown twin, and JSON-LD structured data, so crawlers and agents find the right version on their own.

On every page¶

The bar at the top of a page offers Copy as Markdown (the Markdown twin, ready to paste in a chat), View Markdown, and Open in ChatGPT or Open in Claude, which start a chat with the page already loaded.

Prompts which work well¶

Ask about a feature

Read https://docs.apimaker.dev/v1/docs/apis-all/query-params/deep.md and
https://docs.apimaker.dev/v1/docs/schema/schema.md, then write the schema of my orders table
so that a customer is populated from the customers table in another database.

Write a custom API

Using https://docs.apimaker.dev/v1/examples/custom-apis/custom-api.md and
https://docs.apimaker.dev/v1/docs/pre-defined-terms/global-object-g.md, write a custom API
for API Maker which returns the ten latest orders of the person in g.req.auth.authAMDB.

Give an agent the whole documentation

The documentation of the backend platform we use is at https://docs.apimaker.dev/llms.txt.
Fetch the pages you need from it before answering questions about API Maker.

An assistant in your project folder¶

With the local client (or the Local Client page of API Maker Local Run), every item of the account is a file in a Git repository : src/Custom APIs/…, src/Utility classes/…, src/Schemas/…, hooks, events, schedulers, migrations, test cases and settings. An agent such as Claude Code, Cursor or Copilot can read and change them ; the local client syncs what it saves to API Maker.

Types come with the code : import * as T from 'types' gives every interface of API Maker and import * as db from 'db-interfaces' the interfaces generated from your schemas, so an assistant writes typed code.
Tests run from the terminal : npm run test runs the test cases of the account with their mocks and writes the coverage to coverage/lcov.info.
The security report is in the repository : src/API Security Report/report.md says where a person could read rows which are not theirs and how to fix it. It is kept fresh while the local client is connected, so an assistant can fix hooks, groups and settings and see the result on the next scan. See APIs Security Report & Actions.
The sample account is a tutorial : a new account comes with a sample shop (schemas, custom APIs, hooks, an event, a migration, a utility class) written to be read. Point the assistant at src/Custom APIs/ before asking for something similar.

Swagger for the APIs of your account¶

Every API user can have its own Swagger (OpenAPI) document with the APIs it may call, with a URL to share : enable it on the API user. An assistant which generates a client for your APIs reads it directly.

Tell us what is missing

If an assistant gives a wrong answer about API Maker, the page it read is probably unclear. Write to [email protected] with the question and the page ; it helps every reader.