Discovery

API root: credential check and endpoint index

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.

get/api

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api
  • 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)

Response

The endpoint index.

object'api_index' required
namestring
versionstring required
base_urlstring uri
documentation_urlstring uri required
openapi_urlstring uri required
mcp_urlstring uri required
llms_txt_urlstring uri
notesstring[]

Example response

{
  "version": "v1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.