Version 0.1.0
Bloom API reference
Base URL:
https://trybloom.so
36
Operations
30
Schemas
0
Warnings
API Keys
GET
/api/api-keys
List workspace API keys
POST
/api/api-keys
Create a workspace API key
DELETE
/api/api-keys/{apiKeyId}
Revoke an API key
Artifacts
GET
/api/artifacts/download
Download a run artifact
DELETE
/api/runs/{runId}/artifacts
Delete downloadable artifact references for a run
System
GET
/api/auth/config
Get auth configuration
GET
/api/health
Service health probe
Billing
GET
/api/billing/catalog
List billing plans
POST
/api/billing/checkout
Create a checkout session
POST
/api/billing/portal
Create a customer portal session
Identity
GET
/api/me
Get the authenticated workspace snapshot
Members
GET
/api/members
List workspace members
POST
/api/members
Invite a workspace member
DELETE
/api/members/{memberId}
Remove a workspace member
PATCH
/api/members/{memberId}
Update a member role or status
Migration
GET
/api/migration/summary
Get migration workspace summary
Notifications
GET
/api/notifications
Get workspace notification settings
PATCH
/api/notifications
Update workspace notification settings
Projects
GET
/api/projects
List projects in the workspace
POST
/api/projects
Create a project
DELETE
/api/projects/{projectId}
Archive a project
GET
/api/projects/{projectId}
Get a project
PATCH
/api/projects/{projectId}
Update project settings
Domains
GET
/api/projects/{projectId}/domains
List docs domains for a project
POST
/api/projects/{projectId}/domains
Add or update a docs domain
DELETE
/api/projects/{projectId}/domains/{domainId}
Remove a docs domain
PATCH
/api/projects/{projectId}/domains/{domainId}
Verify, rotate, or update a docs domain
Runs
GET
/api/projects/{projectId}/runs
List runs for a project
GET
/api/runs/{runId}
Get a run by id
POST
/api/runs/{runId}/cancel
Cancel a queued, running, or blocked run
POST
/api/runs/{runId}/retry
Retry a run from retained inputs
Reports
POST
/api/reports/start
Start a migration / generation report run
Publishing
GET
/api/runs/{runId}/publish/dry-run
List publishing actions for a run
POST
/api/runs/{runId}/publish/dry-run
Run an SDK/docs publishing dry-run
POST
/api/runs/{runId}/publish/publish
Request publish approval
POST
/api/runs/{runId}/publish/rollback
Request rollback approval