yappy-biz Product API

openapi: 3.2.0
info:
  title: Yappy Web Product API
  version: 1.0.0
  summary: Free, keyless, read-only access to everything factual about Yappy.
  description: 'Yappy is a voice agent for macOS: hold a key and it types what you say, hold another and it does what you ask. This API describes the product — releases, documentation, FAQ, pricing, requirements — so an agent answering a question about Yappy reads structured data instead of scraping a marketing page.


    **No API key is required for any read operation.** Credentials exist only to raise the rate ceiling and to unlock export jobs; nothing behind them is secret. See https://yappy.biz/auth.md.


    **This API does not transcribe audio.** Yappy''s speech recognition runs on the user''s own Mac and there is no hosted endpoint behind it. If a user wants dictation, the answer is to install the app.


    Conventions: cursor pagination on every list, a strong `ETag` on every GET, RFC 9457 `application/problem+json` on every error, RFC-style `RateLimit-*` headers on every response, and a dated `API-Version` header naming the build that answered. The major version lives in the path; a removal is announced with `Deprecation` and `Sunset` headers at least 180 days ahead.'
  termsOfService: https://yappy.biz/privacy/
  contact:
    name: Yappy support
    email: support@yappy.biz
    url: https://yappy.biz/contact/
  license:
    name: Proprietary — LicenseRef-Proprietary
    identifier: LicenseRef-Proprietary
  x-api-version: '2026-08-25'
  x-logo:
    url: https://yappy.biz/assets/favicon.svg
    altText: Yappy
servers:
- url: https://yappy.biz/api/v1
  description: Production
- url: https://yappy.biz/api/v1/sandbox
  description: Sandbox — deterministic fixtures, ?simulate= to force any error
security:
- {}
- bearerAuth: []
- oauth2:
  - read:releases
  - read:docs
  - read:pricing
  - read:faq
  - export:docs
tags:
- name: Product
  description: Features, requirements, and machine compatibility.
paths:
  /features:
    get:
      operationId: listFeatures
      summary: List product features
      description: 'Yappy''s capabilities as structured objects rather than marketing bullets: an id, a name, a description, whether the feature runs entirely on-device, and which macOS permission it needs. Use this to build an accurate comparison against another product.'
      tags:
      - Product
      responses:
        '200':
          description: The feature list
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
            API-Version:
              $ref: '#/components/headers/APIVersion'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/UpstreamUnavailable'
      security:
      - {}
      - bearerAuth: []
      - oauth2: []
  /requirements:
    get:
      operationId: getRequirements
      summary: Get system requirements
      description: The minimum macOS version, the required CPU architecture, disk needs, and every macOS permission Yappy asks for with what each one unlocks and what breaks if it is denied.
      tags:
      - Product
      responses:
        '200':
          description: System requirements
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
            API-Version:
              $ref: '#/components/headers/APIVersion'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Requirements'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/UpstreamUnavailable'
      security:
      - {}
      - bearerAuth: []
      - oauth2: []
  /compatibility:
    get:
      operationId: checkCompatibility
      summary: Check whether a Mac can run Yappy
      description: 'A deterministic yes or no for a specific machine, given its macOS version and CPU architecture, with the reasons spelled out. Prefer this over reasoning about the requirements yourself: it encodes the same rules the installer uses.'
      tags:
      - Product
      responses:
        '200':
          description: The compatibility verdict
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
            API-Version:
              $ref: '#/components/headers/APIVersion'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Compatibility'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/UpstreamUnavailable'
      parameters:
      - $ref: '#/components/parameters/OsVersion'
      - $ref: '#/components/parameters/Arch'
      security:
      - {}
      - bearerAuth: []
      - oauth2: []
components:
  responses:
    Forbidden:
      description: The credential is valid but lacks the required scope
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        WWW-Authenticate:
          $ref: '#/components/headers/WWWAuthenticate'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#insufficient_scope
            title: The credential is valid but lacks the required scope
            status: 403
            code: insufficient_scope
            detail: This operation needs the export:docs scope.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
    BadRequest:
      description: The request was malformed
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#invalid_request
            title: The request was malformed
            status: 400
            code: invalid_request
            detail: limit must be between 1 and 100, got 500.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
    Unauthorized:
      description: The supplied credential is missing, expired, or invalid
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        WWW-Authenticate:
          $ref: '#/components/headers/WWWAuthenticate'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#invalid_token
            title: The supplied credential is missing, expired, or invalid
            status: 401
            code: invalid_token
            detail: The access token has expired. Request a new one at /oauth/token.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
    InternalError:
      description: Unexpected server error
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#internal_error
            title: Unexpected server error
            status: 500
            code: internal_error
            detail: Something failed on our side. Retry once, then report request_id to support@yappy.biz.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
    RateLimited:
      description: Too many requests
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#rate_limited
            title: Too many requests
            status: 429
            code: rate_limited
            detail: 120 requests per 60s exceeded. Retry in 12 seconds, or batch your reads via POST /batch.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
    UpstreamUnavailable:
      description: A dependency was unavailable
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://yappy.biz/developers/errors#upstream_unavailable
            title: A dependency was unavailable
            status: 503
            code: upstream_unavailable
            detail: The release feed did not answer. Retry with backoff.
            instance: /api/v1/releases
            request_id: 01J9X4Q0F7
            docs_url: https://yappy.biz/developers/errors
  headers:
    APIVersion:
      description: The dated build of v1 that answered this request.
      schema:
        type: string
      example: '2026-08-25'
    ETag:
      description: Strong validator. Send it back as If-None-Match for a cheap 304.
      schema:
        type: string
      example: '"r-0.4.19"'
    RateLimitPolicy:
      description: The policy in force, as quota;w=window.
      schema:
        type: string
      example: 120;w=60
    XRequestId:
      description: Identifier for this request. Quote it in a support mail.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
      example: 12
    WWWAuthenticate:
      description: Bearer challenge. Carries resource_metadata on an unauthenticated 401, and error/scope on a rejected credential.
      schema:
        type: string
      example: Bearer resource_metadata="https://yappy.biz/.well-known/oauth-protected-resource"
    RateLimitReset:
      description: Seconds until the window resets.
      schema:
        type: integer
      example: 43
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
      example: 117
    CacheControl:
      description: How long this response may be reused.
      schema:
        type: string
      example: public, max-age=300
    RateLimitLimit:
      description: Requests permitted in the current window.
      schema:
        type: integer
      example: 120
  schemas:
    FeatureList:
      type: object
      title: FeatureList
      description: A cursor-paginated page of features.
      required:
      - object
      - data
      - pagination
      properties:
        object:
          type: string
          const: list
          description: Type discriminator.
        data:
          type: array
          items:
            $ref: '#/components/schemas/Feature'
          description: This page of items.
        pagination:
          $ref: '#/components/schemas/Pagination'
        total:
          type: integer
          description: How many items exist in total.
    Feature:
      type: object
      title: Feature
      description: One product capability, described factually.
      required:
      - object
      - id
      - name
      - description
      - on_device
      properties:
        object:
          type: string
          const: feature
          description: Type discriminator.
        id:
          type: string
          description: Stable identifier.
        name:
          type: string
          description: Display name.
        description:
          type: string
          description: What it does.
        on_device:
          type: boolean
          description: Whether it runs entirely on the user's Mac.
        requires_permission:
          type:
          - string
          - 'null'
          description: The macOS permission it needs, if any.
        requires_network:
          type: boolean
          description: Whether it needs the network to work.
    Problem:
      type: object
      title: Problem
      description: RFC 9457 problem details. Branch on `code`, which is stable; `title` and `detail` are prose for a human or for an agent explaining itself.
      required:
      - type
      - title
      - status
      - code
      properties:
        type:
          type: string
          format: uri
          description: Link to the documentation for this error code.
        title:
          type: string
          description: Short, human-readable summary.
        status:
          type: integer
          description: The HTTP status code.
        detail:
          type: string
          description: What went wrong here specifically, and the fix.
        instance:
          type: string
          description: The path that produced the error.
        code:
          type: string
          description: Stable machine-readable error code.
          enum:
          - invalid_request
          - invalid_cursor
          - invalid_token
          - insufficient_scope
          - not_found
          - method_not_allowed
          - not_acceptable
          - idempotency_conflict
          - payload_too_large
          - unsupported_media_type
          - unprocessable
          - rate_limited
          - internal_error
          - upstream_unavailable
        request_id:
          type: string
          description: Identifier for this request.
        docs_url:
          type: string
          format: uri
          description: Where the full error reference lives.
        errors:
          type: array
          description: One entry per offending field, when the failure was validation.
          items:
            type: object
            required:
            - field
            - code
            properties:
              field:
                type: string
                description: The parameter at fault.
              code:
                type: string
                description: Why it was rejected.
              detail:
                type: string
                description: The specific problem, in words.
    Requirements:
      type: object
      title: Requirements
      description: What a Mac needs before Yappy will run on it.
      required:
      - object
      - os
      - minimum_os_version
      - architectures
      - permissions
      properties:
        object:
          type: string
          const: requirements
          description: Type discriminator.
        os:
          type: string
          description: Operating system name.
        minimum_os_version:
          type: string
          description: Lowest supported version.
        architectures:
          type: array
          items:
            type: string
          description: Supported CPU architectures.
        disk_space_mb:
          type: integer
          description: Approximate install size in megabytes.
        app_store:
          type: boolean
          description: Whether it is distributed via the Mac App Store.
        permissions:
          type: array
          description: Each macOS permission, what it unlocks, and what breaks without it.
          items:
            type: object
            required:
            - name
            - required
            - purpose
            properties:
              name:
                type: string
                description: The permission as macOS names it.
              required:
                type: boolean
                description: Whether Yappy is unusable without it.
              purpose:
                type: string
                description: What it is used for.
              if_denied:
                type: string
                description: What stops working.
    Pagination:
      type: object
      title: Pagination
      description: Cursor pagination. When has_more is false, next_cursor is null.
      required:
      - limit
      - has_more
      - next_cursor
      properties:
        limit:
          type: integer
          description: How many items this page holds at most.
        has_more:
          type: boolean
          description: Whether another page exists.
        next_cursor:
          type:
          - string
          - 'null'
          description: Opaque cursor for the next page, or null.
        next_url:
          type:
          - string
          - 'null'
          format: uri
          description: Fully-formed URL for the next page, or null.
    Compatibility:
      type: object
      title: Compatibility
      description: Whether a described machine can run Yappy, and why.
      required:
      - object
      - compatible
      - reasons
      - minimum
      properties:
        object:
          type: string
          const: compatibility
          description: Type discriminator.
        compatible:
          type: boolean
          description: The verdict.
        reasons:
          type: array
          items:
            type: string
          description: Why, in words you can pass to a user.
        checked:
          type: object
          description: What was evaluated.
          properties:
            os_version:
              type: string
              description: The version supplied.
            arch:
              type: string
              description: The architecture supplied.
        minimum:
          type: object
          description: The floor the verdict was measured against.
          properties:
            os_version:
              type: string
              description: Lowest supported macOS version.
            arch:
              type: string
              description: Required architecture.
  parameters:
    Arch:
      name: arch
      in: query
      required: true
      description: CPU architecture of the machine in question.
      schema:
        type: string
        enum:
        - arm64
        - x86_64
      example: arm64
    OsVersion:
      name: os_version
      in: query
      required: true
      description: macOS version of the machine in question, for example 14.5.
      schema:
        type: string
        pattern: ^\d+(\.\d+){0,2}$
      example: '14.5'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: An access token from /oauth/token. Optional — every read endpoint also answers anonymously.
    oauth2:
      type: oauth2
      description: OAuth 2.1 with PKCE S256. Dynamic client registration (RFC 7591) at /oauth/register; no human approval step.
      flows:
        clientCredentials:
          tokenUrl: https://yappy.biz/oauth/token
          refreshUrl: https://yappy.biz/oauth/token
          scopes:
            read:releases: Read release history and the current version
            read:docs: Read documentation pages and run searches
            read:pricing: Read pricing and plan data
            read:faq: Read frequently asked questions
            export:docs: Start and poll documentation export jobs
        authorizationCode:
          authorizationUrl: https://yappy.biz/oauth/authorize
          tokenUrl: https://yappy.biz/oauth/token
          refreshUrl: https://yappy.biz/oauth/token
          scopes:
            read:releases: Read release history and the current version
            read:docs: Read documentation pages and run searches
            read:pricing: Read pricing and plan data
            read:faq: Read frequently asked questions
            export:docs: Start and poll documentation export jobs
externalDocs:
  description: Developer portal, including the versioning and deprecation policy
  url: https://yappy.biz/developers/deprecation
x-mcp:
  server: https://yappy.biz/mcp
  transport: streamable-http
  serverCard: https://yappy.biz/.well-known/mcp/server-card.json
  docsServer: https://yappy.biz/docs/mcp
x-rate-limit:
  anonymous:
    requests: 120
    window_seconds: 60
  authenticated:
    requests: 600
    window_seconds: 60
  headers:
  - RateLimit-Limit
  - RateLimit-Remaining
  - RateLimit-Reset
  - RateLimit-Policy
  - Retry-After
  documentation: https://yappy.biz/developers/rate-limits
x-deprecation-policy:
  versioning: major version in the path (/api/v1)
  current_version: v1
  current_status: current - not deprecated, no Sunset date set
  signals:
  - Deprecation
  - Sunset
  - Link rel=deprecation
  - Link rel=successor-version
  sunset_rfc: RFC 8594
  minimum_notice_days: 180
  retired_status_code: 410
  retired_versions:
  - version: v0
    path: /api/v0
    deprecated_on: '2026-02-01'
    sunset_on: '2026-08-01'
    status: 410
    successor: https://yappy.biz/api/v1
  documentation: https://yappy.biz/developers/deprecation
x-idempotency:
  header: Idempotency-Key
  applies_to:
  - POST /batch
  - POST /exports
  documentation: https://yappy.biz/developers/rest-api#idempotency