> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beliefstate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI contract

> Generate REST clients from the published OpenAPI contract.

## Download

Fetch the public OpenAPI 3.1 JSON document directly from BeliefState.

```bash theme={null}
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 theme={null}
npx openapi-typescript https://beliefstate.ai/openapi.json --output beliefstate-api.d.ts
```

## Contract and generated examples

The specification describes the published REST contract. Mintlify generates reference examples from its schemas. Values such as `<string>`, `123`, maximum-size integers, and sample dates are placeholders, not live investor 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. Report a contract mismatch through [support](https://beliefstate.ai/contact) with the endpoint and request ID, without sending credentials.

> 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.

*Last updated: 2026-09-26 · API version: v1 (Latest) · OpenAPI publication: 2026-09-13.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.