API ReferenceModels

Api Models Update

PUT handler with superadmin lock and field protection.

Same as patch() - checks lock and field protection before delegating.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
model_namestringRequired1-255 characters
organizationinteger or nullRequired
projectstring or nullOptional>=1 character
affiliation_categoryenumOptional
  • custom - Custom
  • keywordsai - Keywordsai
is_managedbooleanOptional
is_called_by_custom_namebooleanOptional
base_model_namestringOptional<=255 characters
display_namestringOptional<=255 characters
max_context_windowintegerOptional-2147483648-2147483647
input_costdoubleOptional
output_costdoubleOptional
cache_hit_input_costdoubleOptional
cache_creation_input_costdoubleOptional
respan_discount_ratedouble or nullOptional
streaming_supportintegerOptional-2147483648-2147483647
function_callintegerOptional-2147483648-2147483647
image_supportintegerOptional-2147483648-2147483647
overridden_fieldslist of stringsOptional
load_balance_backupsanyOptional
statusenumOptional
  • active - Active
  • deprecated - Deprecated
is_verifiedbooleanOptional

Whether the model’s pricing has been human-verified. Unverified auto-discovered models are kept out of the live model dictionary.

sourceenumOptional

Source of truth for this model definition

  • hardcoded - Synced from Code
  • db - Database Only
model_typeenumOptional

Type of model: chat, embedding, or audio

  • chat - Chat
  • embedding - Embedding
  • audio - Audio
metadataobjectOptional

Flexible catalog metadata; known keys are documented, extras allowed.

Response

providerobject

Public API serializer for nested provider in model responses - hides internal fields

supported_paramsstringRead-only
model_namestring<=255 characters
idstringRead-only
is_byokbooleanRead-only
effective_discount_ratedoubleRead-only
projectstring or null
affiliation_categoryenum
  • custom - Custom
  • keywordsai - Keywordsai
is_managedboolean
is_called_by_custom_nameboolean
base_model_namestring<=255 characters
display_namestring<=255 characters
max_context_windowinteger-2147483648-2147483647
input_costdouble
output_costdouble
cache_hit_input_costdouble
cache_creation_input_costdouble
respan_discount_ratedouble or null
streaming_supportinteger-2147483648-2147483647
function_callinteger-2147483648-2147483647
image_supportinteger-2147483648-2147483647
overridden_fieldslist of strings
load_balance_backupsany
statusenum
  • active - Active
  • deprecated - Deprecated
is_verifiedboolean

Whether the model’s pricing has been human-verified. Unverified auto-discovered models are kept out of the live model dictionary.

sourceenum

Source of truth for this model definition

  • hardcoded - Synced from Code
  • db - Database Only
model_typeenum

Type of model: chat, embedding, or audio

  • chat - Chat
  • embedding - Embedding
  • audio - Audio
metadataobject

Flexible catalog metadata; known keys are documented, extras allowed.