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

# API reference

> Auto-generated from the live OpenAPI 3.1 spec. Every endpoint, parameter, and response schema.

This reference is generated from the live OpenAPI 3.1 spec for the DSS
Public API. The spec is the source of truth — if the docs and the spec
disagree, the spec wins (and please [tell us](mailto:admin@digitalseaservice.com)
so we can fix the docs).

## Where to find the spec

| Source | Format | Use it for |
| - | - | - |
| [`https://api.digitalseaservice.com/openapi.json`](https://api.digitalseaservice.com/openapi.json) | JSON | Production-current spec from the live API. |
| [`https://api.digitalseaservice.com/openapi.yaml`](https://api.digitalseaservice.com/openapi.yaml) | YAML | Same content, AI-ingestion-friendly. |
| [`/api-reference/openapi.json`](/api-reference/openapi.json) | JSON | The build-time snapshot powering this site. |

## What the spec includes

* All four V1 resource endpoints with full request/response schemas and
  examples.
* The OAuth flow endpoints (`/oauth/authorize`, `/oauth/token`,
  `/oauth/revoke`, `/oauth/userinfo`).
* A complete `oauth2` security scheme — IDE tools and "Try it" widgets pick
  up scopes from this.
* The `servers` array — production and sandbox URLs, switchable from the
  dropdown above each endpoint.
* Pydantic-typed response models with worked examples for every field.

## Suggested AI-agent flow

If you're driving an AI coding agent through your integration:

1. Drop [`llms.txt`](/llms.txt) into context for a map of these docs.
2. Drop [`/openapi.yaml`](/api-reference/openapi.yaml) into context for the
   full API contract.
3. For specific topics, add the page's `.md` view —
   [`/authentication.md`](/authentication.md), etc.

Mintlify also exposes "Copy for ChatGPT" and "Copy for Claude" actions on
every page header, which package the page text + relevant context into a
prompt you can paste straight into a chat.


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