---
title: "Versioned API root: credential check and endpoint index"
method: GET
path: "/api/v1"
tags: ["Discovery"]
---

# Versioned API root: credential check and endpoint index

`GET /api/v1`

## Request

- Base URL: `https://www.adadiamonds.com`
- URL: `https://www.adadiamonds.com/api/v1`
- Auth: one of:
  - none
  - API key in header `X-Ada-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://www.adadiamonds.com/oauth/authorize`, token URL `https://www.adadiamonds.com/api/oauth/token`; client credentials, token URL `https://www.adadiamonds.com/api/oauth/token`, scopes: `catalog:read`)

Returns a map of every endpoint with its operationId and auth requirement, plus the resolved credential (`anonymous` when the request carries none). No credential is needed: the roots are the first URLs an agent tries, and every catalog and content endpoint behind them is open. Protected endpoints answer 401 with a bare `WWW-Authenticate: Bearer` challenge whose `resource_metadata` parameter points at the OAuth protected-resource document.

## Response `200`

The endpoint index.

- ApiIndex
  - `object` 'api_index', required
  - `name` string
  - `version` string, required
  - `base_url` string, uri
  - `credential` Credential
    - `kind` 'anonymous' | 'api_key' | 'access_token', required
    - `env` 'production' | 'sandbox', required
    - `scopes` string[], required
  - `documentation_url` string, uri, required
  - `openapi_url` string, uri, required
  - `mcp_url` string, uri, required
  - `llms_txt_url` string, uri
  - `endpoints` ApiIndexEndpoint[], required
    - `method` string, required
    - `path` string, uri, required
    - `operationId` string, required
    - `auth` string, required: "none" or the required OAuth scope.
  - `notes` string[]

## Other responses

- `429`: Over the rate limit. Wait `Retry-After` seconds; a credential raises the limit.

---

[API](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api.md) · [All operations](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/revisions/2b2ed3201815?raw)