Update a custom model

{
  "id": "my-custom-gpt-4o",
  "model_name": "my-custom-gpt-4o",
  "base_model_name": "gpt-4o",
  "affiliation_category": "custom",
  "is_called_by_custom_name": false,
  "input_cost": 2.5,
  "output_cost": 10,
  "cache_hit_input_cost": 0.5,
  "cache_creation_input_cost": 3,
  "max_context_window": 128000,
  "function_call": 1,
  "image_support": 1,
  "model_type": "chat",
  "supported_params": {},
  "provider": {
    "id": "my-vllm",
    "provider_id": "my-vllm",
    "provider_name": "My vLLM Server",
    "extra_kwargs": {
      "base_url": "https://vllm.example.com/v1"
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
}

Partially update editable fields for a custom model. The model_name field is read-only.

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

Model name. The route supports names containing slashes, such as openai/gpt-4o-mini.

Request

This endpoint expects an object.

base_model_namestringOptional

Base model to inherit properties from.

custom_provider_idstringOptional

Custom provider string ID or provider identifier to associate.

provider_idstringOptional

Alternative to custom_provider_id.

input_costdoubleOptional

Cost per 1M input tokens in USD.

output_costdoubleOptional

Cost per 1M output tokens in USD.

cache_hit_input_costdoubleOptional

Cost per 1M cached input tokens in USD.

cache_creation_input_costdoubleOptional

Cost per 1M cache creation input tokens in USD.

max_context_windowintegerOptional

Maximum context window size.

function_callenumOptional

Allowed values:

image_supportenumOptional

Allowed values:

supported_params_overridemap from strings to anyOptional

Partial override for the model’s parameters: a map of parameter name to a parameter definition with the same shape as supported_params entries (name, type, default, range with min and max, description, required), or null to remove the parameter. Replaces any earlier override. The response returns the computed supported_params.

Response

Updated model.

idstring

Model string ID. Same value as model_name.

model_namestring

Model name used in API calls.

base_model_namestringOptional

Base model inherited from, when configured.

affiliation_categoryenumOptional

keywordsai for built-in models, custom for your organization’s models.

Allowed values:

is_called_by_custom_namebooleanOptional

Whether requests are sent upstream using this custom model name.

input_costdoubleOptional

Cost per 1M input tokens in USD.

output_costdoubleOptional

Cost per 1M output tokens in USD.

cache_hit_input_costdoubleOptional

Cost per 1M cached input tokens in USD.

cache_creation_input_costdoubleOptional

Cost per 1M cache creation input tokens in USD.

max_context_windowintegerOptional

Maximum context window size.

function_callenumOptional

Function/tool calling support. 0 = no, 1 = yes.

Allowed values:

image_supportenumOptional

Vision input support. 0 = no, 1 = yes.

Allowed values:

model_typeenumOptional

Model type.

Allowed values:

supported_paramsmap from strings to anyOptional

Computed parameter support after applying model-specific overrides.

providerobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error