Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
models

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

get/api/models/{model_name}/

Path parameters

model_namestring required

Headers

Authorizationstring required

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, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Response

projectstring nullable
supported_paramsstring required
affiliation_category'custom' | 'keywordsai'
  • custom - Custom
  • keywordsai - Keywordsai
is_managedboolean
is_called_by_custom_nameboolean
model_namestring required
base_model_namestring
display_namestring
max_context_windowinteger
input_costnumber double
output_costnumber double
cache_hit_input_costnumber double
cache_creation_input_costnumber double
respan_discount_ratenumber double nullable
streaming_supportinteger
function_callinteger
image_supportinteger
overridden_fieldsstring[]
{"stackTrail":"components:schemas:PublicModelDetail:properties:load_balance_backups","oasType":"schema","type":"unknown","description":"Any type"}
status'active' | 'deprecated'
  • 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.

source'hardcoded' | 'db'
  • hardcoded - Synced from Code
  • db - Database Only
model_type'chat' | 'embedding' | 'audio'
  • chat - Chat
  • embedding - Embedding
  • audio - Audio
idstring required
is_byokboolean required
effective_discount_ratenumber double required