> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# API Design Standards

> Design conventions behind Photon's public HTTP APIs, why we publish them openly, and how to report inconsistencies.

**Photon API Design Standards (ADS)** are the public design conventions that govern how Photon structures resources, identifiers, URLs, payloads, and errors across its public HTTP APIs. Every standard published here is approved as a binding convention for new and redesigned Photon endpoints.

## Why We Publish These Standards

1. **Predictability across every API**: Once you integrate with one Photon endpoint, every other endpoint should follow the same conventions—whether you are calling the HTTP API directly, using an SDK, or building with an AI agent.
2. **Transparency and design discipline**: Putting our conventions in writing commits Photon to a consistent design bar as the platform grows, rather than letting endpoints drift ad hoc.
3. **Developer accountability**: Publishing our standards in the open gives developers a clear reference to hold us to whenever an endpoint does not match what we promise.

## Feedback & Reporting Issues

We do not accept external pull requests. Instead, please [open an issue in `photon-hq/api-design-standards`](https://github.com/photon-hq/api-design-standards/issues/new) if:

* You find any Photon API endpoint that does not follow these standards. Include the HTTP method, path, standard number (for example `ADS-0001`), and a sanitized or synthetic request or response example with any credentials, tokens, or sensitive customer data removed.
* You have a suggestion to improve an existing standard or want to propose a new convention we should standardize.

## Standards

| Standard | Summary |
| - | - |
| [ADS-0001: Resource Identifiers and Path Parameter Naming](https://docs.photon.codes/docs/beta/ads/ads-0001.md) | Consistent primary identifier fields, qualified foreign keys, and URL path parameter naming across Photon public HTTP APIs. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.