# OpenAPI spec

Generate a typed REST client

> Section: Integrations

> Last updated: **2026-09-26**.

> API version: **v1 (Latest)**. OpenAPI publication: **2026-11-08**.

## Download

Fetch the public OpenAPI 3.1 JSON document directly from BeliefState.

```bash
curl --fail-with-body https://beliefstate.ai/openapi.json --output beliefstate-openapi.json
```

- [Open the current OpenAPI JSON](https://beliefstate.ai/openapi.json)

## Generate types

Use your preferred OpenAPI 3.1 generator. Generated clients stay thin: authentication, requests, pagination, errors, retries, and typed models only.

```bash
npx openapi-typescript https://beliefstate.ai/openapi.json --output beliefstate-api.d.ts
```

## Contract and generated examples

The specification describes the published REST contract.

Generated reference examples use schema placeholders such as <string>, 123, maximum-size integers, and sample dates. They are not live analyst records or evidence of coverage.

Check a real response's schema_version, data_status, warnings, and citations before relying on a field. The generated reference alone does not verify every authenticated production response.

> Feature gated operations appear only after their release flag is enabled. Do not infer availability from a marketing page or an old generated client.

## Agent feedback

Report unclear, stale, or incorrect documentation through [BeliefState support](https://beliefstate.ai/contact). Include this page URL and the smallest reproducible detail.

<!-- BeliefState-Origin: https://beliefstate.ai/docs/openapi; Content-Fingerprint: bs-sha256-a2718082731e9ad324cf3c67cb7f1c971b22af3e9c1c6c6a8bbc89294a935a44 -->