Skip to main content

Features

Tags: capabilities, features

Available platform features and capabilities

Resources​

Request and response models used by the endpoints on this page.

FeatureDefinitionResponse​

FieldTypeRequiredDescription
betaBoolean✓
categoryString✓
dependsOnArray✓
deprecatedBooleanDefault: False
descriptionString✓
iconString
nameString✓
overrideOnlyBooleanDefault: False
productDisplayBooleanDefault: False
productLabelString
productOrderIntegerDefault: 999
recommendedBoolean✓
slugString✓
sunsetDateDate
tagsArray✓
upgradeCtaString
visibilityString✓

Example:

{
"slug": "string",
"name": "string",
"description": "string",
"category": "string",
"tags": [],
"dependsOn": [],
"visibility": "string",
"beta": false,
"recommended": false,
"overrideOnly": false,
"productDisplay": false,
"productOrder": 999,
"deprecated": false
}

FeaturesRegistryResponse​

FieldTypeRequiredDescription
featuresArray<FeatureDefinitionResponse>✓

Example:

{
"features": []
}

Endpoints​

Registry​

GET /api/v2/features/registry

Description:

Get the feature registry with all metadata.

Returns active feature definitions including:

  • Dependencies between features
  • Visibility settings for upgrade prompts
  • Associated abilities, tools, routes, and event types
  • UI configuration (icons)

Authentication: Requires authenticated user

Response: See FeaturesRegistryResponse


Public​

GET /api/v2/features/registry/public

Description:

Public feature registry — no authentication required.

Returns everything a public product card may name, sorted by product_order: flags marked product_display, plus built-in capabilities (lib/features/product_capabilities.py) — always-on things that describe the product without gating it, so retiring an always-on flag doesn't delete its marketing bullet.

Authentication: Public endpoint (no authentication required)

Response: See FeaturesRegistryResponse


Get Slug​

GET /api/v2/features/{slug}

Description:

Get a specific feature definition by slug.

Returns the full feature definition including dependencies, visibility settings, and associated components.

Authentication: Requires authenticated user

Parameters:

  • slug (String)

Response: See FeatureDefinitionResponse