Langfuse JS/TS SDKs
    Preparing search index...

    Interface CreateModelRequest

    interface CreateModelRequest {
        inputPrice?: number;
        matchPattern: string;
        modelName: string;
        outputPrice?: number;
        pricingTiers?: PricingTierInput[];
        startDate?: string;
        tokenizerConfig?: unknown;
        tokenizerId?: string;
        totalPrice?: number;
        unit?: ModelUsageUnit;
    }
    Index

    Properties

    inputPrice? matchPattern modelName outputPrice? pricingTiers? startDate? tokenizerConfig? tokenizerId? totalPrice? unit?

    Properties

    inputPrice?: number

    Deprecated. Use 'pricingTiers' instead. Price (USD) per input unit. Creates a default tier if pricingTiers not provided.

    matchPattern: string

    Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use (?i)^modelname$

    modelName: string

    Name of the model definition. If multiple with the same name exist, they are applied in the following order: (1) custom over built-in, (2) newest according to startTime where model.startTime<observation.startTime

    outputPrice?: number

    Deprecated. Use 'pricingTiers' instead. Price (USD) per output unit. Creates a default tier if pricingTiers not provided.

    pricingTiers?: PricingTierInput[]

    Optional. Array of pricing tiers for this model.

    Use pricing tiers for all models - both those with threshold-based pricing variations and those with simple flat pricing:

    • For models with standard flat pricing: Create a single default tier with your prices (e.g., one tier with isDefault=true, priority=0, conditions=[], and your standard prices)

    • For models with threshold-based pricing: Create a default tier plus additional conditional tiers (e.g., default tier for standard usage + high-volume tier for usage above certain thresholds)

    Requirements:

    • Cannot be provided with flat prices (inputPrice/outputPrice/totalPrice) - use one approach or the other
    • Must include exactly one default tier with isDefault=true, priority=0, and conditions=[]
    • All tier names and priorities must be unique within the model
    • Each tier must define at least one price

    If omitted, you must provide flat prices instead (inputPrice/outputPrice/totalPrice), which will automatically create a single default tier named "Standard".

    startDate?: string

    Apply only to generations which are newer than this ISO date.

    tokenizerConfig?: unknown

    Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details.

    tokenizerId?: string

    Optional. Tokenizer to be applied to observations which match to this model. See docs for more details.

    totalPrice?: number

    Deprecated. Use 'pricingTiers' instead. Price (USD) per total units. Cannot be set if input or output price is set. Creates a default tier if pricingTiers not provided.

    unit?: ModelUsageUnit

    Unit used by this model.

    Settings

    Member Visibility

    On This Page

    Properties