GET /api/v1/openapi.json

The OpenAPI document

The machine-readable contract.

The full OpenAPI 3.1 description of this API, served as JSON. Point code generators, Postman and SDK tooling at it.

It is the authority this reference is built from: the endpoint list, operation ids, summaries, parameters and response schemas on these pages are read out of this object.

The route is not described by the document itself, and it requires no API key. This page is written from the route and from the document it returns.

Path: /api/v1/openapi.json
Authentication: None. This endpoint takes no key.
Rate limit: Not metered. No API key is required.
Operation id: openapiDocument

Parameters

This endpoint takes no parameters.

Example request

The curl works against the live API once OZITUMA_API_KEY holds your key.

curl "https://ozituma.com/api/v1/openapi.json"

The same request, raw

GET /api/v1/openapi.json HTTP/1.1
Host: ozituma.com
Accept: application/json

Example response

{
  "openapi": "3.1.0",
  "info": {
    "title": "Ozituma API",
    "version": "1.0.0",
    "description": "A dictionary API for African languages. Igbo and Yoruba are available today; further languages are added as they are prepared.",
    "license": {
      "name": "Free to use; credit Ozituma",
      "url": "https://ozituma.com/docs#fair-use"
    },
    "contact": { "name": "Ozikoro", "url": "https://ozikoro.com" }
  },
  "servers": [
    { "url": "https://ozituma.com/api/v1", "description": "Production" },
    { "url": "http://localhost:3000/api/v1", "description": "Local development" }
  ],
  "security": [{ "ApiKeyHeader": [] }]
}

Abridged: the served document also carries paths, with one operation per path, and components, with the schemas and the ApiKeyHeader security scheme. What is shown is the info, servers and top-level security exactly as openapi.ts declares them.

Errors

Responses the OpenAPI document lists

The document lists no responses for this operation.

Codes this route can return

None. This route has no documented error responses.

The body of every failure is the same. Errors explained →

Where the document and the implementation differ

Read from the route source and the OpenAPI document together. Where the two disagree, this is what each one says.

The document does not describe this route: /openapi.json is not one of the paths it lists.
The route has no documented error responses. It is unauthenticated and is not metered.