Scalar Registry Read API

Public retrieval of published OpenAPI documents (confirmed public surface).

OpenAPI Specification

scalar-api-registry-read-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Scalar Registry (Public Read Surface) - Modeled Registry Management Registry Read API
  description: MODELED / endpointsModeled. Scalar is an open-source API platform whose hosted Registry stores and versions OpenAPI documents. Published documents are served over a public HTTPS read CDN at registry.scalar.com in the form /@{namespace}/apis/{slug}, optionally with a ?format=json or ?format=yaml query to control the returned representation, and an optional version segment. This document models that public read surface plus the registry lifecycle operations that are performed through the authenticated Scalar CLI (scalar registry publish / list / update / delete). Scalar does NOT publish a fully documented public REST management API; the mutating operations below are modeled from the CLI behavior for cataloging purposes and their exact HTTP shapes are not officially specified. The one confirmed, publicly reachable endpoint is the GET read of a published document (e.g. https://registry.scalar.com/@scalar/apis/galaxy?format=json).
  version: '2026-07-11'
  contact:
    name: Scalar
    url: https://scalar.com
  license:
    name: MIT
    url: https://github.com/scalar/scalar/blob/main/LICENSE
servers:
- url: https://registry.scalar.com
  description: Scalar Registry public read CDN (confirmed). Mutations via Scalar CLI (modeled).
security:
- scalarApiKey: []
tags:
- name: Registry Read
  description: Public retrieval of published OpenAPI documents (confirmed public surface).
paths:
  /@{namespace}/apis/{slug}:
    get:
      tags:
      - Registry Read
      summary: Retrieve a published OpenAPI document (latest version)
      description: Returns the current version of the OpenAPI document published under a namespace and slug. Confirmed public endpoint - e.g. /@scalar/apis/galaxy?format=json. No authentication required for public documents.
      operationId: getRegistryDocument
      security: []
      parameters:
      - name: namespace
        in: path
        required: true
        description: The Scalar team namespace the document was published under.
        schema:
          type: string
        example: scalar
      - name: slug
        in: path
        required: true
        description: The slug identifier of the API document.
        schema:
          type: string
        example: galaxy
      - name: format
        in: query
        required: false
        description: Representation to return.
        schema:
          type: string
          enum:
          - json
          - yaml
        example: json
      responses:
        '200':
          description: The published OpenAPI document.
          content:
            application/json:
              schema:
                type: object
                description: An OpenAPI document.
            application/yaml:
              schema:
                type: string
        '404':
          description: No published document exists for this namespace/slug.
  /@{namespace}/apis/{slug}/{version}:
    get:
      tags:
      - Registry Read
      summary: Retrieve a specific version of a published OpenAPI document
      description: MODELED. Returns a specific pinned version of a published document. Version addressing is supported by the registry; the exact path form is modeled here.
      operationId: getRegistryDocumentVersion
      security: []
      parameters:
      - name: namespace
        in: path
        required: true
        schema:
          type: string
        example: scalar
      - name: slug
        in: path
        required: true
        schema:
          type: string
        example: galaxy
      - name: version
        in: path
        required: true
        description: The published version identifier (e.g. 1.0.0).
        schema:
          type: string
        example: 1.0.0
      - name: format
        in: query
        required: false
        schema:
          type: string
          enum:
          - json
          - yaml
      responses:
        '200':
          description: The published OpenAPI document at the requested version.
          content:
            application/json:
              schema:
                type: object
        '404':
          description: No such version.
components:
  securitySchemes:
    scalarApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: MODELED. Management operations are authenticated via a Scalar API key used by the Scalar CLI. The exact header is not officially documented.