comi-logic/cfw-autumn
8
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: ai credits sdk

Browse Source
This commit is contained in:
Charlie Lamb
2026-06-10 19:20:40 +01:00
parent b3ae7ba1f8
commit f69d4ddf94
119 changed files with 21063 additions and 3028 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
apps/docs/mintlify/api-reference/features/createFeature.mdx
View File

@@ -13,7 +13,7 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
The name of the feature.
</DynamicParamField>
<DynamicParamField body="type" type="'boolean' | 'metered' | 'credit_system'" required>
<DynamicParamField body="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'" required>
The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system.
</DynamicParamField>
@@ -32,7 +32,7 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</DynamicParamField>
<DynamicParamField body="credit_schema" type="object[]">
A schema that maps 'single_use' feature IDs to credit costs. Applicable only for 'credit_system' features.
A schema that maps 'single_use' feature IDs to credit costs. For classic credit systems only — AI credit systems use model_markups instead.
<Expandable title="properties">
<DynamicParamField body="metered_feature_id" type="string" required />
@@ -41,6 +41,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicParamField>
<DynamicParamField body="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.
<Expandable title="properties">
<DynamicParamField body="markup" type="number" />
<DynamicParamField body="input_cost" type="number" />
<DynamicParamField body="output_cost" type="number" />
</Expandable>
</DynamicParamField>
<DynamicParamField body="default_markup" type="number">
Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free.
</DynamicParamField>
<DynamicParamField body="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id.
<Expandable title="properties">
<DynamicParamField body="markup" type="number" required />
</Expandable>
</DynamicParamField>
<DynamicParamField body="event_names" type="string[]" />
<DynamicParamField body="feature_id" type="string" required>
@@ -58,8 +82,8 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
Human-readable name displayed in the dashboard and billing UI.
</DynamicResponseField>
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools, 'ai_credit_system' for model-based token pricing.
</DynamicResponseField>
<DynamicResponseField name="consumable" type="boolean">
@@ -84,6 +108,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
<DynamicResponseField name="input_cost" type="number" />
<DynamicResponseField name="output_cost" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="default_markup" type="number">
Default percentage markup for AI credit systems. Use -100 to make usage free.
</DynamicResponseField>
<DynamicResponseField name="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="display" type="object">
Display names for the feature in billing UI and customer-facing components.
<Expandable title="properties">

28
apps/docs/mintlify/api-reference/features/getFeature.mdx
View File

@@ -24,8 +24,8 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
Human-readable name displayed in the dashboard and billing UI.
</DynamicResponseField>
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools, 'ai_credit_system' for model-based token pricing.
</DynamicResponseField>
<DynamicResponseField name="consumable" type="boolean">
@@ -50,6 +50,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
<DynamicResponseField name="input_cost" type="number" />
<DynamicResponseField name="output_cost" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="default_markup" type="number">
Default percentage markup for AI credit systems. Use -100 to make usage free.
</DynamicResponseField>
<DynamicResponseField name="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="display" type="object">
Display names for the feature in billing UI and customer-facing components.
<Expandable title="properties">

28
apps/docs/mintlify/api-reference/features/listFeatures.mdx
View File

@@ -20,8 +20,8 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
Human-readable name displayed in the dashboard and billing UI.
</DynamicResponseField>
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools, 'ai_credit_system' for model-based token pricing.
</DynamicResponseField>
<DynamicResponseField name="consumable" type="boolean">
@@ -46,6 +46,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
<DynamicResponseField name="input_cost" type="number" />
<DynamicResponseField name="output_cost" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="default_markup" type="number">
Default percentage markup for AI credit systems. Use -100 to make usage free.
</DynamicResponseField>
<DynamicResponseField name="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="display" type="object">
Display names for the feature in billing UI and customer-facing components.
<Expandable title="properties">

56
apps/docs/mintlify/api-reference/features/updateFeature.mdx
View File

@@ -13,7 +13,7 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
The name of the feature.
</DynamicParamField>
<DynamicParamField body="type" type="'boolean' | 'metered' | 'credit_system'">
<DynamicParamField body="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'">
The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system.
</DynamicParamField>
@@ -32,7 +32,7 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</DynamicParamField>
<DynamicParamField body="credit_schema" type="object[]">
A schema that maps 'single_use' feature IDs to credit costs. Applicable only for 'credit_system' features.
A schema that maps 'single_use' feature IDs to credit costs. For classic credit systems only — AI credit systems use model_markups instead.
<Expandable title="properties">
<DynamicParamField body="metered_feature_id" type="string" required />
@@ -41,6 +41,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicParamField>
<DynamicParamField body="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.
<Expandable title="properties">
<DynamicParamField body="markup" type="number" />
<DynamicParamField body="input_cost" type="number" />
<DynamicParamField body="output_cost" type="number" />
</Expandable>
</DynamicParamField>
<DynamicParamField body="default_markup" type="number">
Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free.
</DynamicParamField>
<DynamicParamField body="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id.
<Expandable title="properties">
<DynamicParamField body="markup" type="number" required />
</Expandable>
</DynamicParamField>
<DynamicParamField body="event_names" type="string[]" />
<DynamicParamField body="archived" type="boolean">
@@ -66,8 +90,8 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
Human-readable name displayed in the dashboard and billing UI.
</DynamicResponseField>
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
<DynamicResponseField name="type" type="'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'">
Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools, 'ai_credit_system' for model-based token pricing.
</DynamicResponseField>
<DynamicResponseField name="consumable" type="boolean">
@@ -92,6 +116,30 @@ import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="model_markups.{key}" type="object | null">
Per-model markup overrides for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
<DynamicResponseField name="input_cost" type="number" />
<DynamicResponseField name="output_cost" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="default_markup" type="number">
Default percentage markup for AI credit systems. Use -100 to make usage free.
</DynamicResponseField>
<DynamicResponseField name="provider_markups.{key}" type="object | null">
Per-provider default markup percentages for AI credit systems.
<Expandable title="properties">
<DynamicResponseField name="markup" type="number" />
</Expandable>
</DynamicResponseField>
<DynamicResponseField name="display" type="object">
Display names for the feature in billing UI and customer-facing components.
<Expandable title="properties">