For coding agents
Coding agents such as Claude Code, Cursor, and GitHub Copilot write better PreForm automations when they read these docs as text. Every page on this site is published in forms an agent reads directly, generated from the same source as the pages at build time.
Machine-readable entry points#
| Path | What it holds |
|---|---|
/llms.txt | An index of every page with a one-line summary, the points to know before writing code against the SDK, and the link to the specification, following llmstxt.org |
/llms-full.txt | Every guide and example page in one Markdown file, for an agent that reads the whole site into its context |
A page's URL with .md for its trailing slash | That page as Markdown, with its code samples inlined and its links pointing at other pages' Markdown copies. This page is /resources/for-coding-agents.md |
An API reference page's Markdown copy, such as /api-reference/scenes.md | A list of that page's endpoints, each with its method and path, its SDK method, and a link to its own Markdown copy, such as /api-reference/scenes/create-scene.md. Each schema has one too, such as /api-reference/schemas/scene.md, so an agent fetches the one endpoint it needs |
/reference/openapi-v1.yml | The PreForm API v1 specification, OpenAPI 3 in YAML |
The API reference pages are generated from the specification, and so is the Python SDK's client, so what the specification describes is what the SDK does. Each SDK method is an operationId from the specification in snake_case. Every HTML page also declares its Markdown copy with <link rel="alternate" type="text/markdown">.
Point your agent at the docs#
Add these lines to the instructions file your agent reads in your project, such as AGENTS.md, CLAUDE.md, or .cursor/rules:
## Formlabs PreForm automation
This project uses the Formlabs Python SDK (`formlabs-sdk`, imported as `formlabs_sdk`)
to drive PreForm and PreForm Server. Before writing or changing code that calls it:
- Read https://developer.formlabs.com/llms.txt and follow its links to the pages you
need.
- Look up endpoints, fields, and error codes in
https://developer.formlabs.com/reference/openapi-v1.yml or the API reference's
Markdown pages. Don't guess method or field names.
- Start from the Python sample on the endpoint's reference page.An agent that loads a whole site before it starts takes llms-full.txt instead. It holds the guides and the examples; the endpoints are in the API reference's Markdown pages and the specification.