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

# API overview

> The complete public REST contract and its live OpenAPI specification.

The generated endpoint pages in this section are the complete public REST reference. They are built from the same live OpenAPI specification as the running API.

## Spec URL

```text theme={null}
https://www.trybloom.ai/api/v1/spec.json
```

The specification defines the current public paths, authentication, request fields, response schemas, and error codes. Routes still changing in private beta are omitted until Bloom can support them as stable public contracts.

Base URL:

```text theme={null}
https://www.trybloom.ai/api/v1
```

## What you can do with it

* Generate a typed SDK with [openapi-typescript](https://github.com/drwpow/openapi-typescript), [OpenAPI Generator](https://openapi-generator.tech/), or another OpenAPI tool.
* Import the API into Postman, HTTPie, or Insomnia.
* Give the specification to an agent that needs the exact REST contract.
* Compare a generated client with the live schema in continuous integration.

## Quick example

Generate TypeScript types directly from the live spec:

```bash theme={null}
npx openapi-typescript https://www.trybloom.ai/api/v1/spec.json -o bloom-api.d.ts
```

Or save the spec locally to inspect or feed into another tool:

```bash theme={null}
curl https://www.trybloom.ai/api/v1/spec.json -o bloom-spec.json
```

The spec follows OpenAPI 3.1.1. Start with the [API quickstart](/api) for an end-to-end request or [API authentication](/api/authentication) for credential details.