Versioning and changes

The version of the ewpire API is part of its address. Every endpoint lives under /v1:

Base URL: https://ewpire.com/api/v1

There is one version, v1. No version header or date is sent with a request: the path is all of it.

API keys are not open yet, and until they open v1 itself can still change. The rules on this page apply from the day keys open.

What v1 is

• Requests and answers follow the OpenAI chat completions format. Where ewpire differs is listed in Chat.
• Every error has one shape, an error object with message, type, param and code, described in Errors.
• An address under /v1 that does not exist answers 404 with the code not_found in that same shape.
• A parameter the API does not support is refused with 400 unsupported_parameter, not ignored.

The endpoints, their parameters and their answers are also published as an OpenAPI 3.1 document at /openapi.json.

Changes that can appear without notice

Additive changes are made inside v1 and can appear at any time:

• a new endpoint;
• a new optional request parameter, or a new accepted value of an existing one;
• a new field in an answer, a new response header, or a new error code under an existing status.

Write your client so that it ignores fields it does not know and handles an error code it does not know by its HTTP status.

Breaking changes

A change that would break a client written for v1 is not made inside v1: it gets a new version prefix, /v2, next to it. Breaking means removing or renaming a field, changing its type, making an optional parameter required, or changing what an existing parameter, status or error code means.

This page says how the API changes, not how long a version is kept: no period is set for keeping an older version once a newer one exists. The Terms of Service apply to the API as they do to the rest of ewpire.

What is not versioned

The model catalog is not part of the version. Models are added and removed, and their prices change, without a new version: read GET /models rather than hard-coding a list, and handle 404 model_not_found. See Models.

The limits in these docs – requests per minute and the size of a request – can be adjusted without a new version as well. See Rate limits.

Where changes are announced

Changes to the API are listed by date in the changelog, together with changes to the rest of ewpire. The day each section of these docs last changed is printed under its title.