Files
cfw-autumn/shared/api/features/crud/common/baseFeatureParamsV1.ts
Charlie Lamb 8822664df9 feat: AI credit system with model-based token pricing
Adds a new FeatureType.AiCreditSystem that enables model-based token
pricing with per-model markup configuration. Includes the @useautumn/ai-sdk
package for Vercel AI SDK integration with automatic token tracking.

Co-authored-by: TheUntraceable <73362400+TheUntraceable@users.noreply.github.com>
2026-05-19 19:05:37 +01:00

57 lines
1.9 KiB
TypeScript

import { z } from "zod/v4";
import { ModelMarkupsSchema } from "../../../../models/featureModels/featureConfig/creditConfig";
import { FeatureType } from "../../../../models/featureModels/featureEnums";
import { idRegex } from "../../../../utils/utils";
export const BaseFeatureV1ParamsSchema = z.object({
id: z.string().nonempty().regex(idRegex).meta({
description:
"The ID of the feature. This is used to refer to it in other API calls like /track or /check.",
}),
name: z
.string()
.nonempty()
.optional()
.meta({ description: "The name of the feature." }),
type: z.enum(FeatureType).meta({
description:
"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.",
}),
consumable: z.boolean().optional().meta({
description:
"Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features.",
}),
display: z
.object({
singular: z.string(),
plural: z.string(),
})
.optional()
.meta({
description:
"Singular and plural display names for the feature in your user interface.",
}),
credit_schema: z
.array(
z.object({
metered_feature_id: z.string(),
credit_cost: z.number(),
}),
)
.optional()
.meta({
description:
"A schema that maps 'single_use' feature IDs to credit costs. For classic credit systems only — AI credit systems use model_markups instead.",
}),
model_markups: ModelMarkupsSchema.optional().meta({
description:
"Per-model markup percentages for AI credit systems. Maps model IDs to their markup configuration.",
}),
event_names: z.array(z.string()).optional(),
});