Register Custom Model

Register a custom language model with the organization that owns the API key.

The model configuration is validated by making a test API call before saving.

Request body

namestring required

The name of the custom language model

identifierstring required

The identifier of the custom language model (e.g. openai/gpt-4o, azure/gpt-5)

providerstring nullable

Provider name (auto-detected from identifier if not specified)

typestring nullable

Model type: 'llm' (default), 'embedding', or 'image'

extraobject

Provider-specific configuration (e.g. api_base, api_version, region)

api_keystring nullable

The API key or credentials for the model

Successful Response

idstring uuid required

The ID of the custom language model

namestring required

The name of the custom language model

identifierstring required

The identifier of the custom language model

providerstring nullable

Provider name

typestring nullable

Model type: llm, embedding, or image

extraobject

Provider-specific configuration