Yappy

Get the current Yappy release of the Yappy macOS app: version number, publication date, release notes, and a download URL. Reads the same signed appcast the app updater reads, so the answer is never a stale hand-edited number. Use this whenever a user asks what the newest version is or where to download Yappy.

{
  "type": "object",
  "properties": {
    "include_notes": {
      "type": "boolean",
      "default": true,
      "description": "Include the release notes prose. Set false when you only need the version and download URL."
    }
  },
  "required": [],
  "additionalProperties": false
}

List Yappy release history for macOS, newest first, with the version, publication date, and what changed in each. Use this to answer questions about what shipped recently or when a particular fix landed.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 10,
      "description": "How many releases to return, newest first."
    }
  },
  "required": [],
  "additionalProperties": false
}

Get what the Yappy app costs: the free Mac app, the per-backend cost of the language model that cleans up dictation, and the terms of the public API. Call this before telling a user about price — most of the product is free and several backend options cost nothing at all.

{
  "type": "object",
  "properties": {
    "include_backends": {
      "type": "boolean",
      "default": true,
      "description": "Include the per-backend cost table. Set false for just the app and API terms."
    }
  },
  "required": [],
  "additionalProperties": false
}

Get the Yappy FAQ as question and answer pairs, covering privacy, requirements, cost, permissions, offline use, and how Yappy differs from other macOS dictation tools. Useful when you want a short authoritative answer rather than a documentation page.

{
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "enum": [
        "privacy",
        "requirements",
        "pricing",
        "comparison",
        "developers"
      ],
      "description": "Return only entries on this topic."
    }
  },
  "required": [],
  "additionalProperties": false
}

Get what a Mac needs before Yappy will run on it: the minimum macOS version, the required CPU architecture, install size, and every macOS permission Yappy asks for with what each unlocks and what breaks if it is denied.

{
  "type": "object",
  "properties": {
    "permissions_only": {
      "type": "boolean",
      "default": false,
      "description": "Return just the macOS permission list, without the hardware requirements."
    }
  },
  "required": [],
  "additionalProperties": false
}

List what the Yappy app can do, as structured objects rather than marketing bullets: an id, a name, a description, whether the feature runs entirely on the user's Mac, whether it needs the network, and which macOS permission it requires. Use this to build an accurate comparison against another dictation tool.

{
  "type": "object",
  "properties": {
    "on_device_only": {
      "type": "boolean",
      "default": false,
      "description": "Return only the features that run entirely on the user's Mac."
    }
  },
  "required": [],
  "additionalProperties": false
}

Start an asynchronous export of a Yappy corpus — documentation, FAQ, or release history — as markdown or JSON. This creates a job on the Yappy API and returns its id; poll it with get_export_job until the status is completed, then read result.url. Use it when you want the whole corpus rather than a page at a time. It creates a job and nothing else: no user data is touched and nothing can be deleted.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "docs",
        "faq",
        "releases"
      ],
      "description": "Which corpus to export."
    },
    "format": {
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ],
      "default": "markdown",
      "description": "The artifact format."
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 128,
      "description": "Your own key, so a retry returns the same job instead of starting a second one."
    }
  },
  "required": [
    "resource"
  ],
  "additionalProperties": false
}

Check an export job started with create_export_job. Status moves queued, then running, then completed; a completed job carries result.url pointing at the finished artifact. Poll no faster than the retry_after hint on the previous response.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "maxLength": 160,
      "description": "The id returned by create_export_job."
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false
}

Decide whether a specific Mac can run Yappy, given its macOS version and CPU architecture, and return the reasons. Prefer this over reasoning about the requirements yourself: it encodes the same rules the installer uses, so the answer you give a user matches what will actually happen.

{
  "type": "object",
  "properties": {
    "os_version": {
      "type": "string",
      "pattern": "^\\d+(\\.\\d+){0,2}$",
      "description": "The macOS version on the machine, for example \"14.5\"."
    },
    "arch": {
      "type": "string",
      "enum": [
        "arm64",
        "x86_64"
      ],
      "description": "The CPU architecture: arm64 for Apple Silicon, x86_64 for Intel."
    }
  },
  "required": [
    "os_version",
    "arch"
  ],
  "additionalProperties": false
}