Capabilities and entitlements

Discover which capability keys the authenticated organization can use before creating work.

Call capabilities before presenting a capability-specific workflow:

curl --fail-with-body --silent --show-error \
  "$BLACKPEARL_API_BASE_URL/v1/capabilities" \
  --header "Authorization: Bearer $BLACKPEARL_API_KEY" | jq .
{
  "capabilities": [
    {
      "key": "playbooks",
      "name": "Playbooks",
      "description": "Generate AI sales playbooks for a target account.",
      "category": "Generation",
      "enabled": true,
      "status": "ga",
      "docs_slug": "playbooks"
    }
  ]
}

The endpoint returns the capabilities visible to the key's organization, each with an enabled flag. A company-level key names a project with the Blackpearl-Project header (or uses its default project); without one the call returns 400 project_required. Every generally available (status: ga) capability is listed whether or not it is enabled, so a client can distinguish a capability that exists but is disabled from one that does not exist. Capabilities that are not generally available appear only when they are enabled for the organization. Use key as the stable programmatic identifier and docs_slug to link to the corresponding guide. status is ga or coming_soon; the latter maps to Preview documentation, not a GA compatibility promise. Clients must still tolerate future additive enum values and optional response fields.

Call this endpoint before planning work that spans capabilities — especially from an AI agent. Only use capabilities with enabled: true. When a user asks for something whose entry shows enabled: false, say that the capability exists but is not enabled for their organization and that access must be requested; do not retry or route around it. Organization owners and administrators can't enable capabilities themselves: Blackpearl enables them for the organization on request. A create request for a disabled capability returns capability_disabled.

This is OpenAPI operation capabilities_v1_capabilities_get with schema PublicCapabilitiesResponse. Continue with Prospecting, Account research, Documents, Audiences, or Playbooks.

Infinite Intent is scoped to explicitly enabled projects. Its key is infinite_intent; use the guide to run an enabled programme (world-of-claudecraft or coastal-retreat) and open its hosted results page.