Skip to Content
ReferenceOpenAPI Spec

OpenAPI 3.1 Specification

The Celper AI API provides a machine-readable OpenAPI 3.1 specification that defines every endpoint, parameter, request body, and response schema. Use it with API clients, documentation tools, and code generators.

Download openapi.yaml

Using with Postman

  1. Open Postman and go to File > Import.
  2. Select the downloaded openapi.yaml file.
  3. Postman will generate a collection with all API endpoints pre-configured.
  4. Set the X-API-Key variable in your environment to your Celper AI API key.
  5. Start making requests.

Using with Insomnia

  1. Open Insomnia and go to Application > Preferences > Data > Import Data > From File.
  2. Select the openapi.yaml file.
  3. Configure the X-API-Key header in the base environment.

Using with Code Generators

The OpenAPI spec works with OpenAPI Generator  to produce client libraries in dozens of languages.

Python client:

openapi-generator-cli generate \
  -i openapi.yaml \
  -g python \
  -o ./celper-python-client \
  --additional-properties=packageName=celper_ai

TypeScript client:

openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-fetch \
  -o ./celper-ts-client

Java client:

openapi-generator-cli generate \
  -i openapi.yaml \
  -g java \
  -o ./celper-java-client

API Version

The current API version is v1. The version is included in the base path of all endpoints (/v1/...).

The OpenAPI specification is updated alongside API changes. When new endpoints or fields are added, the spec is published with the same release. Check the info.version field in the spec for the exact version number.

Error Codes