OpenAPI Spec

Download the Spec

The specification is available as a JSON file. You can view it in your browser or download it for use with code generation tools.

Import into Postman

Import the full API collection into Postman in three steps:

1. Open Postman and click Import in the top left.
2. Select the Link tab and paste: https://preflightapi.io/api/openapi
3. After import, go to the collection's Variables tab and set Ocp-Apim-Subscription-Key to your API key. All requests in the collection will use it automatically.

Import into Insomnia

Import the API into Insomnia in three steps:

1. Open Insomnia and go to File → Import → From URL.
2. Paste the spec URL: https://preflightapi.io/api/openapi
3. Create an environment variable for your API key and reference it as a header in each request, or set the header at the folder level.

Generate Typed Clients

Use popular open-source tools to generate fully typed API clients from the spec. Choose the approach that best fits your workflow.

openapi-typescript

Generate TypeScript types directly from the spec. Lightweight and zero-runtime — produces only type definitions.

npm install -D openapi-typescript

openapi-fetch

Pair with openapi-typescript for a fully type-safe fetch client. Autocompletes paths, parameters, and response shapes at compile time.

npm install openapi-fetch
npm install -D openapi-typescript

Orval

Generate React Query (TanStack Query) hooks automatically. Ideal for React apps — gives you ready-to-use hooks with caching, refetching, and error handling built in.

npm install -D orval