Entitlements API
Resolve plan tier, feature gates, and policy for the authenticated user/project. Used by the CLI to decide which agents and workflows are available.
Truth note (bs-8328): The live control-plane route is
GET/POST /api/v1/entitlements/resolve. Older docs that listed/v1/entitlements,/v1/entitlements/:feature, and a published@bootspring/sdkclient were incorrect.
Endpoints
| Method | Endpoint | Description | Status |
|---|---|---|---|
GET | /api/v1/entitlements/resolve | Resolve tier + feature gates | Live |
POST | /api/v1/entitlements/resolve | Same resolve with body/project context | Live |
Resolve entitlements
Headers
| Header | Required | Description |
|---|---|---|
Authorization: Bearer bs_… or X-API-Key | Yes | API key |
X-Project-Id | Optional | Scope resolve to a project |
Example
What you get back
The resolve payload includes:
- Current plan/tier
- Feature gate strings available to that tier (agents, skills, workflows, telemetry, support, team, presence, audit, policies)
- Agent tier requirements for gated experts
- Policy profile fields used by the CLI
Treat the response as the source of truth for "can this key use this feature?" rather than hard-coding plan matrices in client code.
Feature gates (illustrative)
Gates expand by tier. Exact lists live in the resolve response:
| Tier | Includes (examples) |
|---|---|
| Free | agents.technical, skills.basic, workflows.basic, telemetry |
| Pro | + business agents, advanced skills/workflows, priority support |
| Team | + enterprise agents/skills/workflows, team features, presence |
| Enterprise | + audit logs, custom policies, wildcard agent/skill/workflow gates |
SSO/SCIM and other enterprise identity products remain roadmap / feature-gated on the product surface — do not treat them as production-live just because a gate string exists in planning docs.
Client usage
curl / fetch (Live)
CLI / MCP (Live)
Typed SDKs (Roadmap)
There is no published @bootspring/sdk. Do not document import { Bootspring } from '@bootspring/sdk'. Use REST, CLI, or MCP until official SDKs ship.
Related
- Agents API
- API keys
- Pricing model (internal ops doc if present)