Scalar

Scalar Utility API

The utility API from Scalar — 3 operation(s) for utility.

GitHub OpenAPI

Operations 3

POST /feedback Postfeedback #
POST /signup-data Postsignup data #
POST /waitlist Postwaitlist #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/openapi/scalar-utility-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-project-version-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-theme-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-email-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scalar-utility-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scalar-utility-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scalar Utility API
  contact:
    name: Marc from Scalar
    url: https://scalar.com
    email: support@scalar.com
  version: '1.0'
  description: 'Operations tagged utility across 2 of this provider''s published API definitions: scalar-core.json, scalar-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.scalar.com/core
security:
- BearerAuth: []
tags:
- name: Utility
paths:
  /feedback:
    post:
      tags:
      - Utility
      description: Submit app feedback
      operationId: postfeedback
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  $ref: '#/components/schemas/email'
                feedback:
                  type: string
                  minLength: 5
              required:
              - email
              - feedback
              additionalProperties: false
        required: true
      summary: Postfeedback
      x-summary-source: derived
  /signup-data:
    post:
      tags:
      - Utility
      description: Save docs data on signup
      operationId: postsignupData
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  dataUid:
                    type: string
                required:
                - dataUid
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      security: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                version:
                  $ref: '#/components/schemas/project-version'
                theme:
                  $ref: '#/components/schemas/theme'
                yjsDocs:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
                yjsReferences:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
              required:
              - version
              - yjsDocs
              - yjsReferences
              additionalProperties: false
        required: true
      summary: Postsignup data
      x-summary-source: derived
  /waitlist:
    post:
      tags:
      - Utility
      description: Submit app feedback
      operationId: postwaitlist
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      security: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    anyOf:
                    - type: string
                    - type: number
                    - type: boolean
                email:
                  $ref: '#/components/schemas/email'
                products:
                  type: array
                  items:
                    type: string
                    enum:
                    - client
              required:
              - email
              - products
              additionalProperties: false
        required: true
      summary: Postwaitlist
      x-summary-source: derived
components:
  schemas:
    '404':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    header-link-version-selector:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: version-selector
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      additionalProperties: false
    header-link-group:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: group
        children:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/header-link-guide'
            - $ref: '#/components/schemas/header-link-reference'
            - $ref: '#/components/schemas/header-link-external'
          description: Children of the group. Groups cannot contain other groups, spacers, or the version selector
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      - children
      additionalProperties: false
    '422':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    project-version:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        name:
          default: Default Version
          type: string
        primaryGuideId:
          type: string
        primaryReferenceId:
          type: string
        references:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/reference'
        guides:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/guide'
        header:
          type: array
          items:
            $ref: '#/components/schemas/header-link'
        footer:
          default: ''
          type: string
        footerCss:
          default: ''
          type: string
        footerBelowSidebar:
          default: false
          type: boolean
        headScript:
          default: ''
          type: string
        bodyScript:
          default: ''
          type: string
      required:
      - uid
      - name
      - primaryGuideId
      - primaryReferenceId
      - references
      - guides
      - header
      - footer
      - footerCss
      - footerBelowSidebar
      - headScript
      - bodyScript
      additionalProperties: false
    project-icon-info:
      type: object
      properties:
        src:
          default: ''
          type: string
        title:
          type: string
        mask:
          type: boolean
      required:
      - src
      additionalProperties: false
    header-link-spacer:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: spacer
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      additionalProperties: false
    nanoid:
      type: string
      minLength: 5
    sidebar-page:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
          minLength: 1
        type:
          type: string
          const: Page
        link:
          type: string
        icon:
          $ref: '#/components/schemas/project-icon'
        children:
          default: []
          type: array
          items:
            type: string
        description:
          type: string
        show:
          type: boolean
        sidebarTitle:
          type: string
        defaultOpen:
          type: boolean
        yjsReference:
          type: string
        backgroundImage:
          type: string
        isMdx:
          default: false
          type: boolean
        isHtml:
          default: false
          type: boolean
      required:
      - uid
      - title
      - type
      - children
      - description
      - show
      - yjsReference
      - isMdx
      - isHtml
      additionalProperties: false
    slug:
      type: string
      minLength: 3
      maxLength: 60
      pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
    email:
      type: string
      format: email
      pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
    sidebar-folder:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
          minLength: 1
        type:
          type: string
          const: Folder
        link:
          type: string
        icon:
          $ref: '#/components/schemas/project-icon'
        children:
          default: []
          type: array
          items:
            type: string
        description:
          type: string
        show:
          type: boolean
        defaultOpen:
          type: boolean
      required:
      - uid
      - title
      - type
      - children
      - show
      additionalProperties: false
    namespace:
      type: string
      minLength: 3
      maxLength: 50
      pattern: ^[a-zA-Z0-9-_]+$
    theme:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        name:
          type: string
        description:
          type: string
        theme:
          type: string
        slug:
          $ref: '#/components/schemas/slug'
      required:
      - uid
      - name
      - description
      - theme
      - slug
      additionalProperties: false
    header-link-guide:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: guide
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      additionalProperties: false
    header-link-reference:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: reference
        hasPermalink:
          default: false
          description: Whether the reference has a permalinked reference or not
          type: boolean
        hasManagedDoc:
          default: false
          description: Whether the reference has a linked registry API
          type: boolean
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      - hasPermalink
      - hasManagedDoc
      additionalProperties: false
    sidebar-link:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
          minLength: 1
        type:
          type: string
          const: Link
        link:
          type: string
        icon:
          $ref: '#/components/schemas/project-icon'
        children:
          type: array
          items:
            type: string
        description:
          type: string
        show:
          type: boolean
      required:
      - uid
      - title
      - type
      - link
      - show
      additionalProperties: false
    '401':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    header-link:
      anyOf:
      - $ref: '#/components/schemas/header-link-guide'
      - $ref: '#/components/schemas/header-link-reference'
      - $ref: '#/components/schemas/header-link-group'
      - $ref: '#/components/schemas/header-link-external'
      - $ref: '#/components/schemas/header-link-version-selector'
      - $ref: '#/components/schemas/header-link-spacer'
    sidebar:
      type: object
      properties:
        items:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/sidebar-item'
        children:
          type: array
          items:
            type: string
      required:
      - items
      - children
      additionalProperties: false
    project-icon:
      $ref: '#/components/schemas/project-icon-info'
    reference-managed-doc:
      type: object
      properties:
        namespace:
          $ref: '#/components/schemas/namespace'
        slug:
          $ref: '#/components/schemas/slug'
        versions:
          default:
          - latest
          type: array
          items:
            type: string
      required:
      - namespace
      - slug
      - versions
      additionalProperties: false
    '403':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    guide:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        description:
          type: string
        sidebar:
          $ref: '#/components/schemas/sidebar'
        show:
          default: true
          type: boolean
        isButton:
          default: false
          type: boolean
        isStarred:
          default: false
          type: boolean
      required:
      - uid
      - title
      - description
      - sidebar
      - show
      - isButton
      - isStarred
      additionalProperties: false
    '400':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    reference:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        description:
          type: string
        yjsReference:
          $ref: '#/components/schemas/nanoid'
        config:
          default: '{}'
          type: string
        specPermalink:
          default: ''
          type: string
        managedDoc:
          default: null
          anyOf:
          - $ref: '#/components/schemas/reference-managed-doc'
          - type: 'null'
        show:
          default: true
          type: boolean
        isButton:
          default: false
          type: boolean
        isStarred:
          default: false
          type: boolean
      required:
      - uid
      - title
      - description
      - yjsReference
      - config
      - specPermalink
      - managedDoc
      - show
      - isButton
      - isStarred
      additionalProperties: false
    header-link-external:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
        show:
          default: true
          type: boolean
        isStarred:
          default: false
          type: boolean
        type:
          type: string
          const: link
        isButton:
          default: false
          type: boolean
        link:
          type: string
      required:
      - uid
      - title
      - show
      - isStarred
      - type
      - isButton
      - link
      additionalProperties: false
    '500':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    sidebar-item:
      anyOf:
      - $ref: '#/components/schemas/sidebar-link'
      - $ref: '#/components/schemas/sidebar-page'
      - $ref: '#/components/schemas/sidebar-folder'
    '404_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Resource not found.
        code: not-found
    '422_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: The request body contains invalid values.
        code: invalid-payload
    nanoid_2:
      type: string
      minLength: 5
      examples:
      - UakgbKJ5m9gl0JDMbcJqL
    slug_2:
      type: string
      minLength: 1
      maxLength: 60
      pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
      examples:
      - acme-api
    email_2:
      type: string
      format: email
      pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
      examples:
      - alex@example.com
    namespace_2:
      type: string
      minLength: 2
      maxLength: 50
      pattern: ^[a-zA-Z0-9-_]+$
      examples:
      - acme
    theme_2:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid_2'
        name:
          type: string
          examples:
          - Acme Theme
        description:
          type: string
          examples:
          - Custom colors for Acme documentation.
        theme:
          type: string
          examples:
          - ':root { --scalar-color-1: #1f2937; }'
        slug:
          examples:
          - acme-theme
          $ref: '#/components/schemas/slug_2'
      required:
      - uid
      - name
      - description
      - theme
      - slug
      additionalProperties: false
    '401_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid authentication token.
        code: unauthorized
    '403_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: You do not have permission to access this resource.
        code: forbidden
    '400_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid request parameters.
        code: bad-request
    '500_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: An unexpected error occurred.
        code: unknown
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- scalar-core.json
- scalar-openapi.json