Service

Discovery index

GET/

Public discovery of resource paths, publication, authentication and the supported response version. An accepted bearer key can also supply account access details; discovery does not require a key.

Parameters0

This endpoint takes no parameters.

Responses1

  • 200

    The index.

Response schema19 fields

  • namestringRequired
  • descriptionstringRequired
  • documentationstring (uri)Required
  • openapistring (uri)Required
  • openapi_well_knownstring (uri)Required
  • docsstring (uri)Required
  • mcpobject

    The read-only MCP server. Each tool sends one GET to this API with the caller’s key.

  • entitlementsstring[]

    Resources the sent key can read. Present only when the request carries a known key.

  • pinned_versionstring

    The response version the sent key is pinned to. Present only when the request carries a known key.

  • catalog_releasestring

    The build the sent key reads now. Pass it to /changes as after. Present only when the request carries a known key and the live build was read.

  • catalog_publishedstring (date-time)

    When catalog_release was published. Present with catalog_release.

  • versionobjectRequired
  • authenticationobjectRequired
  • rate_limitobjectRequired

    The default cap and the window it applies over, stated before the first request rather than only on the RateLimit-* headers of the response to it. A key’s own cap can differ and is always on RateLimit-Limit.

  • resourcesobject[]Required
  • conventionsobjectRequired

    Shared rules for list order, absent fields and served document depth.

  • coverageobjectRequired

    Published catalog counts by manufacturer and release year. Use coverage to assess the published scope before interpreting an empty result.

  • changesobject

    Club ids each catalog release changed. Use it to refresh a stored copy without a full rescan.

  • healthstring (uri)Required

This page as Markdown