# Machine-readable docs

These docs are published for agents as well as people.

## URLs

| What | URL |
|---|---|
| Any page as plain markdown | `https://siftware.dev/docs/<path>.md` |
| Index of every page | `https://siftware.dev/llms.txt` |
| Every page in one file | `https://siftware.dev/llms-full.txt` |
| OpenAPI JSON for the REST API | `https://app.siftware.dev/api-docs/openapi.json` |

## How to use them

- Add `.md` to a page's path to get its markdown. The page `https://siftware.dev/docs/ai/rest-api` is
  `https://siftware.dev/docs/ai/rest-api.md`.
- Read `llms.txt` first. It lists each page with a one-line description and its markdown address.
- Read `llms-full.txt` to load everything in one request.
- Use the OpenAPI file to generate a client or to check an endpoint's fields.

## Limits

- Only pages published on the site are served. The site build that serves these is new; check the index for
  what is there.
- The OpenAPI file is served by the app and describes the endpoints the workspace has switched on.

## Related

- [REST API](/docs/ai/rest-api.md)
- [Connect an agent](/docs/ai/connect-an-agent.md)