OpenAPI Spec

The machine-readable description of every endpoint.

The full surface of the API is described in an OpenAPI 3.1 document. It is the source of truth for the API reference and for every generated client.

curl -O https://developers.firsty.app/api-reference/openapi.json

Generating a client

Any OpenAPI-compatible generator will work:

npx openapi-typescript openapi.json -o firsty-api.d.ts

One caveat: the spec marks nullable fields with the OpenAPI 3.0-style nullable: true, which some 3.1-strict generators ignore. If your generated types claim a field can't be null but the reference says it can (for example lifecycleStatus, capacityMb, nextCursor), trust the reference and treat the field as nullable.

The spec is versioned alongside the API (info.version). Pin the version you generated against so a future additive change doesn't silently alter your types.