API ReferenceModels

Retrieve Custom Model

GET/PATCH/DELETE /llm_models/model/<pk>/ (platform - uses pk) GET/PATCH/DELETE /api/models/<path:model_name>/ (public API - uses model_name) Unified endpoint for any model (global or custom). Lookup field determined by URL kwargs: - If 'pk' in kwargs: Uses pk lookup - If 'model_name' in kwargs: Uses model_name lookup GET: Retrieve model (public for global, org auth for custom) PATCH: Update model (admin for global, org owner for custom) DELETE: Delete model (admin for global, org owner for custom) Permission logic: - Global model (organization_id is None): Admin required for write - Custom model (organization_id is set): Org ownership required for write

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

model_namestringRequired

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.