Skip to content

Models

ModelItem

Bases: BaseModel

Comprehensive model information and metadata.

This model represents a complete model entity with all associated configuration, pricing information, capabilities, and organizational details. Models can be either library-provided or user-configured.

Attributes:

Name Type Description
category Optional[str]

Model category (e.g., "Multimodal", "NLP", "ImageGeneration")

id str

Unique model identifier

display_name str

Human-readable model name

model_name str

Technical model identifier/name

prompt_id Optional[str]

Optional system prompt identifier

system_prompt Optional[ModelSystemPrompt]

Optional system prompt configuration

source_type str

Model source ("Library" or "UserProvided")

type str

Model type (e.g., "Text", "Image")

provider str

AI provider (e.g., "OpenAI", "Anthropic", "Google")

tenant_id str

Tenant/organization identifier

project_id Optional[str]

Optional project identifier

project_name Optional[str]

Optional project name

project Optional[ModelProject]

Optional project details

created_at datetime

Model creation timestamp

updated_at datetime

Last modification timestamp

user_id str

User who created/configured the model

has_tool_support bool

Whether model supports tool calling

has_stream_support bool

Whether model supports streaming responses

library_model_id Optional[str]

Optional library model identifier

user_provided_details ModelUserProvidedDetails

Configuration details for user-provided models

allow_airia_credentials bool

Whether Airia-managed credentials are allowed

allow_byok_credentials bool

Whether bring-your-own-key credentials are allowed

price_type str

Pricing model type

model_parameters List[Any]

Additional model parameters

route_through_acc bool

Whether to route through Airia Credentials Controller

ModelProject

Bases: BaseModel

Basic project information associated with a model.

Represents a simplified view of project data within model contexts, containing only essential identification information.

ModelSystemPrompt

Bases: BaseModel

System prompt information associated with a model.

Contains details about the system prompt template used by the model, including version tracking and project associations.

ModelUserProvidedDetails

Bases: BaseModel

User-provided configuration details for a model.

Contains authentication, pricing, and deployment information for models configured by users.