OpenAPI Specification

The Zenovay External API is described by a live OpenAPI 3.1 spec served directly from the API. Fetch it any time to generate client SDKs, import into API testing tools, or build custom integrations.

Live spec

curl https://api.zenovay.com/api/external/v1/openapi.json | jq .info

The endpoint is public (no API key required to read the spec itself; you still need a key to call any documented endpoint). It's edge-cached for 5 minutes.

Specification Overview

Endpoints Covered

The specification documents all External API endpoints, including the Pro+ Stats API:

Using with Tools

Import into Postman

1. Open Postman and go to Import
2. Paste the URL https://api.zenovay.com/api/external/v1/openapi.json
3. Postman will create a collection with all endpoints pre-configured
4. Set the X-API-Key variable in your environment

Import into Insomnia

1. Open Insomnia and go to Import/Export > Import Data
2. Choose From URL and enter https://api.zenovay.com/api/external/v1/openapi.json
3. All endpoints will appear in a new workspace

Generate TypeScript Client

npx openapi-typescript-codegen \
--input https://api.zenovay.com/api/external/v1/openapi.json \
--output ./src/api-client

Generate Python Client

pip install openapi-python-client
openapi-python-client generate \
--url https://api.zenovay.com/api/external/v1/openapi.json

Schema Highlights

Response Envelope

Every successful response uses the envelope:

{
"success": true,
"data": { ... },
"timestamp": "2026-02-07T12:00:00.000Z"
}

Every error response uses:

{
"success": false,
"error": {
  "message": "Human-readable error description",
  "code": "UNAUTHORIZED",
  "timestamp": "2026-02-07T12:00:00.000Z"
}
}

Error Codes

The spec defines these error codes:

Related Resources

• API Endpoints Overview - Full endpoint documentation
• Authentication - API key management
• API Playground - Test endpoints interactively