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 enabled capabilities for the key's 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.

Console visibility and execution entitlement are independent internal controls. The public response includes only executable capabilities. A create request for unavailable functionality returns capability_disabled; obtain access before retrying.

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