REST API
Overview
The REST API exposes Tenant configuration, Agent execution, durable resources,
and usage under /v1. Set BLAZING_AGENTS_BASE_URL to your deployment's API
origin; the repository does not define a universal hosted production hostname.
Use it from a trusted backend when the TypeScript SDK is not the right integration surface.
Keep bearer credentials on the backend
A Blazing Agents API key grants access to the whole Tenant. Never put it in browser or mobile code; route end-user requests through your backend.
curl "$BLAZING_AGENTS_BASE_URL/v1/me" \
--header "Authorization: Bearer $BLAZING_AGENTS_DASHBOARD_JWT"Conventions
JSON endpoints use application/json; Skill and avatar uploads use multipart
form data. Generation and Session Turns can return AI SDK-native streams, and
Artifact downloads return raw bytes. Every authenticated operation is scoped
to the credential's Tenant. Most operations accept either a ba_ API key or a
dashboard JWT; GET /v1/me
requires the JWT.
Responses include X-Request-Id. Send that header yourself to preserve a
request identifier across services. Errors use the canonical
error envelope, while streams can report later
failures in protocol-native error chunks.
Resources
| Resource | Operations |
|---|---|
| Agents | Configuration, Versions, lifecycle, avatars, and MCP Attachments |
| API keys | One-time key minting, listing, and revocation |
| Tenant | Current identity and mutable settings |
| Providers | BYOK configuration and tests |
| MCP connections | Connection lifecycle, testing, and OAuth |
| MCP OAuth | Dashboard approval continuation |
| Sandboxes | Durable execution environments |
| Generation | Stateless text and structured output |
| Sessions | Stateful Turns, transcripts, and Tool approvals |
| Artifacts | Listing, byte download, and deletion |
| Memories | Agent-owned durable notes |
| Prompts | Reusable message templates |
| Skills | Tenant uploads and platform catalog |
| Usage | Tenant and Agent usage queries |
| Tasks | Asynchronous definitions and schedules |
| Task runs | Execution, polling, and cancellation |
Shared contracts
SDK relationship
The TypeScript SDK wraps this same /v1 surface.
Use raw REST from another backend language or when you need direct control of
headers and streams. SDK-only compositions, such as restoring an Agent Version,
can make more than one REST request and are labeled as such.