Replace Custom Model

PUT

https://api.respan.ai/api/models/:model_name/

PUT

/api/models/:model_name/

$ curl -X PUT https://api.respan.ai/api/models/model_name/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "project": "string",
3   "model_name": "string",
4   "affiliation_category": "custom",
5   "is_managed": true,
6   "is_called_by_custom_name": true,
7   "base_model_name": "string",
8   "display_name": "string",
9   "max_context_window": 1,
10   "input_cost": 1.1,
11   "output_cost": 1.1,
12   "cache_hit_input_cost": 1.1,
13   "cache_creation_input_cost": 1.1,
14   "respan_discount_rate": 1.1,
15   "streaming_support": 1,
16   "function_call": 1,
17   "image_support": 1,
18   "overridden_fields": [
19     "string"
20   ],
21   "status": "active",
22   "is_verified": true,
23   "source": "hardcoded",
24   "model_type": "chat",
25   "metadata": {
26     "privacy_policy_url": "string",
27     "zero_data_retention": true,
28     "prompt_training": true,
29     "prompt_logging": true,
30     "moderation": true,
31     "is_available_on_credits": true,
32     "stream_cancellation_supported": true,
33     "precision": "string",
34     "quantization": "string",
35     "release_date": "string",
36     "context_size": 1,
37     "weekly_tokens": 1,
38     "daily_tokens": 1,
39     "benchmarks": {
40       "deepswe": {
41         "version": "string",
42         "generated_at": "string",
43         "n_tasks_in_set": 1,
44         "model": "string",
45         "harness": "string",
46         "reasoning_effort": "string",
47         "config": "string",
48         "source": "string",
49         "pass_rate": 0.5,
50         "pass_at_1": 0.5,
51         "pass_at_4": 0.5
52       }
53     }
54   },
55   "provider": 1
56 }

PUT handler with superadmin lock and field protection.

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

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, 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.

AuthorizationBearer

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

Path parameters

model_namestringRequired

Request

This endpoint expects an object.

supported_params_overrideanyOptional

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.

providerinteger or nullOptional

Response

projectstring or nullRead-only

model_namestringRead-only