Skip to Content
API access is available to organizations with a signed BAA. Request API access →
Docs for AI agents

Docs for AI agents

These docs are also published in machine-readable formats for LLMs and coding agents. Point your agent at any of these resources.

ResourceURLUse it for
llms.txt/developers/api/llms.txtAn index of every page with a one-line summary.
llms-full.txt/developers/api/llms-full.txtEvery page’s full text in one file, ready to drop into context.
Page MarkdownAdd .md to any page URL, like /developers/api/patient-api-quickstart.mdOne page as clean Markdown.
OpenAPI 3.1/developers/api/openapi/bloomtext-api.yamlGenerating clients, tools, and typed SDKs. Includes the API key scheme and scopes; features BloomText turns on per account are marked x-status: planned. Also as JSON.
OpenAPI 3.0 and Swagger 2.0/developers/api/openapi/bloomtext-api-3.0.yaml, /developers/api/openapi/bloomtext-api-2.0.yamlTools that can’t read 3.1, like Okta Workflows (3.0) and Microsoft Power Automate connectors (2.0). Generated from the 3.1 spec.
Agent skill/developers/api/skills/bloomtext-api/SKILL.mdTeaching Claude Code, Codex, and other agents the API’s rules. See Agent skill.

Copy any page

Use the Copy page menu at the top of any page to copy it as Markdown, or to open it in ChatGPT or Claude and ask questions about it.

Give your agent the whole API

Build a BloomText integration

Use the BloomText API docs at https://www.bloomtext.com/developers/api/llms-full.txt and the OpenAPI spec at https://www.bloomtext.com/developers/api/openapi/bloomtext-api.yaml. For patient operations, my server uses an API key from BLOOMTEXT_API_KEY as a Bearer token; every patient operation names its patient by ID, phone number, or MRN. A key that reaches several organizations passes org_id from GET /orgs on every call. Staff provisioning uses /members and /teams. Operations marked x-status: planned are turned on per account and return an error until BloomText turns them on. Send an Idempotency-Key on every POST. Help me build the integration.

Agent skill

The BloomText API skill teaches a coding agent the API’s rules: API keys, scopes and org_id, search syntax, idempotency, pagination, error codes, and what never to send. Agents that support Agent Skills  load it automatically for tasks that involve BloomText.

Terminal
mkdir -p .claude/skills/bloomtext-api curl -o .claude/skills/bloomtext-api/SKILL.md https://www.bloomtext.com/developers/api/skills/bloomtext-api/SKILL.md

To have an AI agent read and act in BloomText for your users, instead of writing code against the API, see Build an AI agent.

Last updated on