OpenAPI Specification

NovaKit provides a complete OpenAPI 3.1 specification that you can use to generate client libraries, explore the API, or import into tools like Postman, Insomnia, or Swagger UI.

Download

Choose your preferred format:

• JSON: Download openapi.json
• YAML: Download openapi.yaml

Quick Links

Using the Spec

Import into Postman

1. Open Postman and click Import
2. Select Link and paste: https://www.novakit.ai/api/openapi
3. Click Import to generate a collection

Generate Client Libraries

Use OpenAPI Generator to create client libraries:

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate TypeScript client
openapi-generator-cli generate \
  -i https://www.novakit.ai/api/openapi \
  -g typescript-fetch \
  -o ./novakit-client

# Generate Python client
openapi-generator-cli generate \
  -i https://www.novakit.ai/api/openapi \
  -g python \
  -o ./novakit-python

View in Swagger UI

You can view the interactive API documentation using Swagger UI:

docker run -p 8080:8080 \
  -e SWAGGER_JSON_URL=https://www.novakit.ai/api/openapi \
  swaggerapi/swagger-ui

Then open http://localhost:8080 in your browser.

Spec Overview

The OpenAPI specification includes:

Authentication

All endpoints use Bearer token authentication:

securitySchemes:
  BearerAuth:
    type: http
    scheme: bearer

Include your API key in the Authorization header:

Authorization: Bearer sk_your_api_key