Raycast Extension API (SDK)

The primary developer interface - the @raycast/api npm package. A strongly typed TypeScript/Node SDK (installed via `npm i @raycast/api`) providing React UI components (List, Detail, Form, Grid, Action) plus modules for Storage, Cache, Clipboard, Preferences, OAuth, Environment, Keyboard, Window Management, Menu Bar Commands, and Browser Extension. This is a client-side library invoked from within extensions, not an HTTP REST API.

OpenAPI Specification

raycast-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Raycast Extension API (SDK)
  description: >-
    Raycast's developer surface is NOT a public HTTP REST API. It is the
    @raycast/api TypeScript/Node SDK (installed with `npm i @raycast/api`) used
    to build Raycast extensions with React. Capabilities - AI (`AI.ask`),
    Storage, Cache, Clipboard, Preferences, OAuth, Environment, Window
    Management, Menu Bar Commands, and Browser Extension - are exposed as
    SDK modules and React components invoked from inside an extension's
    process, not as network endpoints. There is no documented public base URL,
    no request/response HTTP contract, and no authenticated REST surface to
    model. This OpenAPI document therefore intentionally declares an empty
    `paths` object: it exists to register the provider in the API Evangelist
    catalog and to make the SDK-based nature of the interface explicit. No REST
    endpoints have been fabricated. Developers should consult the SDK reference
    at https://developers.raycast.com/api-reference for the actual TypeScript
    API.
  termsOfService: https://www.raycast.com/terms
  contact:
    name: Raycast Developers
    url: https://developers.raycast.com/
  version: '1.0'
servers:
  - url: https://developers.raycast.com
    description: >-
      Documentation host only. Raycast does not expose a public REST API base
      URL; the SDK runs locally inside extensions.
paths: {}
components:
  schemas: {}