Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.trybloom.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Bloom API ships a live OpenAPI spec — point any tool that speaks OpenAPI at the URL below and you’re done.

​
Spec URL

https://www.trybloom.ai/api/v1/spec.json
The spec is generated directly from the running API, so it always reflects the live contract — no drift between docs and runtime.

​
What you can do with it

  • Generate a typed SDK in any language using openapi-typescript, openapi-generator, or your tool of choice.
  • Import into Postman, HTTPie or Insomnia to explore every endpoint with one click.
  • Feed it to an AI agent so it can call Bloom endpoints without hand-written tool definitions.
  • Drive CI checks — fail builds when a downstream client gets out of sync with the spec.

​
Quick example

Generate TypeScript types directly from the live spec: 
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: 
curl https://www.trybloom.ai/api/v1/spec.json -o bloom-spec.json

​
Version

The spec follows OpenAPI 3.1.1. Endpoint shapes are stable — we only add fields, never remove or rename without a versioned migration path.