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, an index lists them all for agents, 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, with the code in TypeScript only and without the raw output of the benchmarks. Upload it to a tool which searches its files (a project knowledge base), or give an agent `llms.txt` and let it fetch the pages it needs.
One part of it	`llms-getting-started.txt`, `llms-security.txt`, `llms-build.txt`, `llms-operate.txt`, `llms-code-examples.txt`, `llms-benchmarks.txt`, `llms-release-notes.txt`	The pages of one tab of the navigation, the same way : a smaller file for an assistant which works on one part.
Any page as Markdown	the page URL with `.md` instead of `.html`, for example `/v4/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/v4/docs/apis-all/query-params/deep.md and
https://docs.apimaker.dev/v4/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/v4/examples/custom-apis/custom-api.md and
https://docs.apimaker.dev/v4/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.

Write a page of an SSR website

Read https://docs.apimaker.dev/v4/docs/ssr/ai-guide.md and https://docs.apimaker.dev/v4/docs/ssr/data.md,
then write pages/account/orders.tsx for my SSR website : the orders of the signed-in customer,
newest first, 20 per page, and the rule of site.config.ts which keeps each customer to its own orders.

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 Launchpad), 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, settings and the SSR websites (src/ssr/…). An agent such as Claude Code, Cursor or Copilot can read and change them ; the local client syncs what it saves to API Maker.

The repository explains itself : API Maker writes an AGENTS.md at its root, the guide an agent reads before it starts.
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.

AGENTS.md in your repository¶

Agents such as Codex, Cursor, Copilot and Claude Code read a file called AGENTS.md at the root of a folder before they work in it. API Maker writes one into the Git repository of the account on every commit, so an agent knows API Maker before its first question :

Where things are : the folder of every kind of item, the files of an item (its YAML, its code, its settings in TypeScript), how to add one, and the files API Maker writes, which an agent never edits.
How code is written : main and g in all eight languages, the calls of g.sys, hooks, utility classes, test cases, and where the exact types are (am-types/types.ts, src/types/db-interfaces.d.ts).
The rules of security : the two gates, the row scoping pre-hook, secrets, what code must never do.
The security report : how to read src/api_security_report/report.md, fix a finding in the file it names and see it go, without ever skipping a finding : a skip is the decision of your team.
How to check a change : the local client, npm run test, the type checks of each language, and the pages of these docs as Markdown.

It is about 13 KB, short enough to be read at the start of every session, and it goes with the version of API Maker : an update of API Maker brings the guide of that version with the next commit.

The guide is a block between two lines,  and . Every commit writes the block again; what you write before or after it is yours and stays as it is. A repository which has an AGENTS.md of its own gets the block after its text.

AGENTS.md

<!-- api-maker:begin : written by API Maker on every commit. Edit outside this block : it is written again. -->
# API Maker project : guide for AI agents
…
<!-- api-maker:end -->

# Our team

- Every new table gets a row scoping pre-hook before its first API user.
- Ask Diya before a migration script which deletes rows.

The file comes to your folder with git pull, with the rest of the commit. The local client does not write it : git refuses a pull which would replace a file it does not track.
The Git page lists it under AGENTS.md (guide for AI agents) the first time, and after an update of API Maker which changed the guide. It can not be reverted from the page : the next commit writes it again.
Claude Code reads CLAUDE.md : a CLAUDE.md with the line @AGENTS.md makes it read the guide too.

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.