Building with AI agents
If you use an AI coding agent (Claude Code, Cursor, Copilot, or similar) to build against the DUST platform, this site ships two kinds of machine-readable material: llms.txt indexes of the documentation, and integration skills — self-contained instruction files your agent can load to integrate correctly on the first pass.
Everything on this page is generated from the same sources as the docs themselves (the documentation content and the current OpenAPI spec) on every build, and carries the docs version it was generated from — so it cannot silently drift from the API.
llms.txt
Section titled “llms.txt”Following the llms.txt convention, the site root serves:
| File | Contents |
|---|---|
/llms.txt |
Site map: every page with a one-line description, plus pointers to the OpenAPI spec, the interactive reference, and the npm packages |
/llms-full.txt |
The full documentation content as a single plaintext document |
/llms-small.txt |
A minified variant for smaller context windows |
Point your agent at /llms.txt to let it pick pages, or feed it /llms-full.txt when it needs the whole picture.
The OpenAPI spec
Section titled “The OpenAPI spec”The authoritative API surface is the OpenAPI 3 document:
- Live from the API server:
https://apid.dustid.io/api/openapi.json - A build-time copy on this site:
/openapi.json - Interactive reference (Scalar):
https://apid.dustid.io/api/docs
Integration skills
Section titled “Integration skills”A skill is a single Markdown file in the SKILL.md format (YAML frontmatter with name and description, then instructions) that teaches an agent one integration end to end — auth, headers, the core flows, and the failure modes. The skills are versioned and self-contained: an agent that has only the skill file can complete the integration.
The endpoint index inside dice-api-integration is generated from the OpenAPI spec at build time; both files record the docs and spec versions they were generated from.
Installing a skill
Section titled “Installing a skill”-
Download the skill file from the stable URL above (e.g.
/skills/dice-api-integration/SKILL.md). -
For Claude Code, place it at
.claude/skills/dice-api-integration/SKILL.mdin your project (the directory name matches the skill’sname). Claude discovers it automatically and loads it when the task matches. -
For other agents, include the file in the agent’s context or system prompt — the file is plain Markdown and self-contained.
npm packages
Section titled “npm packages”@dustid/dust-go-connect— the DUST Go scanning bridge for web apps (see Integrate with DUST Go).@dustid/apid-client— the typed TypeScript API client (see TypeScript client for availability).
