Model Types

API Documentation Reference: Model types conform to the GET /v1/models response schema. The SDK provides TypeScript types that match the API 1:1 with no modifications. Browse available models in the Model Catalog.

See Models for usage.

Model

SDK representation of the Model object returned from the Models API. This TypeScript interface matches the API JSON response exactly — returned by GET /v1/models and GET /v1/models/:slug. The SDK performs no transformations.

interface Model {
  name: string;
  description: string;
  namespace: string;
  type: ModelType;
  privacy: ModelPrivacy;
  img_url: string | null;
  vendor: Vendor;
  billable: boolean;
  pricing: Pricing;
  capabilities: string[];
  metadata: ModelMetadata;
  status: string;
  service: Service;
  input_schema: ModelInputSchema | null;
  output_schema: ModelOutputSchema | null;
}

Field	Type	Description
`name`	`string`	Display name.
`description`	`string`	Model description.
`namespace`	`string`	API slug — pass to `client.run()`.
`type`	`ModelType`	Content type.
`privacy`	`ModelPrivacy`	`'public'` or `'private'`.
`img_url`	`string \| null`	Model image URL.
`vendor`	`Vendor`	Provider info.
`billable`	`boolean`	Whether predictions are billed.
`pricing`	`Pricing`	Cost info. See Pricing.
`capabilities`	`string[]`	e.g. `['text-to-image', 'image-to-image']`.
`metadata`	`ModelMetadata`	Runtime hints.
`status`	`string`	`'operational'` or `'offline'`.
`service`	`Service`	Inference service info.
`input_schema`	`ModelInputSchema \| null`	JSON Schema for inputs (when requested via `fields`).
`output_schema`	`ModelOutputSchema \| null`	JSON Schema for outputs (when requested via `fields`).

Vendor

interface Vendor {
  name: string;
  description: string;
  image_url: string;
  verified: boolean;
  slug: string;
  metadata: unknown;
}

Field	Type	Description
`name`	`string`	Vendor name.
`description`	`string`	Vendor description.
`image_url`	`string`	Vendor logo URL.
`verified`	`boolean`	Whether the vendor is verified.
`slug`	`string`	Vendor slug.
`metadata`	`unknown`	Vendor metadata.

Pricing

interface Pricing {
  amount: number;
  currency: string;
  unit: string;
  criterias: PricingCriteria[];
  formula: PricingFormula;
}

Field	Type	Description
`amount`	`number`	Price per unit.
`currency`	`string`	Currency code (e.g. `'USD'`).
`unit`	`string`	Billing unit — see `PricingUnit`.
`criterias`	`PricingCriteria[]`	Conditional pricing rules.
`formula`	`PricingFormula`	Computed pricing formula.

PricingCriteria

interface PricingCriteria {
  field: string;
  description: string;
  operator: PricingOperator;
  value: string | boolean | number;
  billable_price: number;
  unit: string;
}

Field	Type	Description
`field`	`string`	Input field to evaluate.
`description`	`string`	Human-readable description.
`operator`	`PricingOperator`	`'equals'` or `'=='`.
`value`	`string \| boolean \| number`	Value to compare.
`billable_price`	`number`	Price when criteria matches.
`unit`	`string`	Billing unit for this criteria.

PricingFormula

interface PricingFormula {
  description: string;
  type: string;
  variables: Record<string, number>;
  terms: PricingFormulaTerm[];
  result_key: string;
}

Field	Type	Description
`description`	`string`	Formula description.
`type`	`string`	Formula type.
`variables`	`Record<string, number>`	Variable values.
`terms`	`PricingFormulaTerm[]`	Formula terms.
`result_key`	`string`	Result variable name.

ModelMetadata

interface ModelMetadata {
  edge_compatible: boolean;
  openai_compatible: boolean;
  cold_boot: boolean;
  deployment_hardware: DeploymentHardware;
}

Field	Type	Description
`edge_compatible`	`boolean`	Works in edge runtimes.
`openai_compatible`	`boolean`	Has OpenAI-compatible interface.
`cold_boot`	`boolean`	Requires cold boot.
`deployment_hardware`	`DeploymentHardware`	Hardware info.

DeploymentHardware

interface DeploymentHardware {
  type: string;
  slug: string;
}

Field	Type	Description
`type`	`string`	Hardware type.
`slug`	`string`	Hardware slug.

ModelInputSchema / ModelOutputSchema

interface ModelInputSchema {
  type: string;
  title: string;
  required: string[];
  properties: Record<string, Record<string, any>>;
}

type ModelOutputSchema = ModelInputSchema;

Field	Type	Description
`type`	`string`	JSON Schema type.
`title`	`string`	Schema title.
`required`	`string[]`	Required fields.
`properties`	`Record<string, ...>`	Property definitions.

ModelFieldsOptions

interface ModelFieldsOptions {
  fields: ('input_schema' | 'output_schema')[];
}

Field	Type	Description
`fields`	`('input_schema' \| 'output_schema')[]`	Extra fields to include.

Service

interface Service {
  type: string;
  inference_party: string;
}

Field	Type	Description
`type`	`string`	Service type.
`inference_party`	`string`	Which party runs inference.

SDK Models — Complete models implementation guide
Models API — API documentation for models
Model Catalog — Browse all available models

Model Enums

enum ModelType {
  IMAGE      = 'image',
  VIDEO      = 'video',
  AUDIO      = 'audio',
  MUSIC      = 'music',
  TEXT       = 'text',
  CODE       = 'code',
  MULTIMODAL = 'multimodal',
}

enum ModelPrivacy {
  PUBLIC  = 'public',
  PRIVATE = 'private',
}

enum PricingUnit {
  IMAGE             = 'image',
  VIDEO             = 'video',
  SECOND            = 'second',
  PREDICTION        = 'prediction',
  GPU               = 'gpu',
  IMAGE_MEGAPIXEL   = 'image_megapixel',
  COMPUTING_SECOND  = 'computing_second',
  AUDIO_SECOND      = 'audio_second',
  VIDEO_SECOND      = 'video_second',
  TOKEN             = 'token',
  FIVE_SECONDS      = '5 seconds',
  MINUTE            = 'minute',
}

enum PricingOperator {
  EQUALS        = 'equals',
  DOUBLE_EQUALS = '==',
}

How is this guide?

On this page