Skip to Content

POST /model/get

Get Model

Get model information using the canonical shared model operation.

Request Body (GetModelApiRequest)

FieldTypeRequiredDescription
idstringNoModel unique identifier
model_idstringNoLegacy alias for model unique identifier
draft_idstringNoDraft unique identifier
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__model__types__SectionFilterNoFilter options for names
descriptionsapp__infra__model__types__SectionFilterNoFilter options for descriptions
valuesapp__infra__model__types__SectionFilterNoFilter options for values
providersapp__infra__model__types__SectionFilterNoFilter options for providers
flagsapp__infra__model__types__SectionFilterNoFilter options for flags
departmentsapp__infra__model__types__SectionFilterNoFilter options for departments
modalitiesapp__infra__model__types__SectionFilterNoFilter options for modalities
temperature_levelsapp__infra__model__types__SectionFilterNoFilter options for temperature levels
pricingapp__infra__model__types__SectionFilterNoFilter options for pricing
reasoning_levelsapp__infra__model__types__SectionFilterNoFilter options for reasoning levels
qualitiesapp__infra__model__types__SectionFilterNoFilter options for qualities
voicesapp__infra__model__types__SectionFilterNoFilter options for voices

Response (GetModelApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current actor
model_existsbooleanNoWhether the model exists
can_editbooleanNoWhether the current user can edit
disabled_reasonstringNoReason editing is disabled
group_idstringNoGroup identifier for the model
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches.
model_idstringNoModel identifier
show_ai_generatebooleanNoWhether any step should show AI generate
basic_show_ai_generatebooleanNoShow AI generate for basic step
provider_show_ai_generatebooleanNoShow AI generate for provider step
features_show_ai_generatebooleanNoShow AI generate for features step
pending_idsstring[]NoPending resource identifiers when available
namesModelNameResource[]NoName resources
descriptionsModelDescriptionResource[]NoDescription resources
valuesModelValueResource[]NoValue resources
providersModelProviderResource[]NoProvider resources
flagsModelFlagResource[]NoFlag configs
departmentsModelDepartmentResource[]NoDepartment resources
modalitiesModelModalityResource[]NoModality resources
temperature_levelsModelTemperatureLevelResource[]NoTemperature level resources
pricingModelPricingResource[]NoPricing resources
reasoning_levelsModelReasoningLevelResource[]NoReasoning level resources
qualitiesModelQualityResource[]NoQuality resources
voicesModelVoiceResource[]NoVoice resources
Last updated on