Skip to main content
GET
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

selected_model
string | null

Response

Successful Response

display_name
string
required

Display name of the model. This is used for display purposes in the Console UI.

Example:

"GPT-4o"

deprecated
boolean
required

Whether the model is in the deprecation warning window.

Example:

false

provider
enum<string>
default:azure_openai

Provider of the LLM model.

Available options:
anthropic,
azure_openai,
google,
openai
Example:

"azure_openai"

model
string
default:gpt-4o

Name of the model. Must match the deployment name in Azure AI Studio.

Example:

"gpt-4o"

version
string | null
deprecated

Deprecated model version retained for backward compatibility.

Example:

"2024-05-13"

api_version
string | null

Version of the provider's API.

Example:

"2024-06-01"

sunset_date
string<date> | null

Date the model becomes retired and can no longer be saved or selected.

Example:

null

removed
boolean
default:false

Whether the model is force-retired regardless of sunset_date.

Example:

false

fallback
string | null

Model substituted at runtime for critical features once this one is retired.

Example:

null

status
enum<string> | null

Effective lifecycle status, resolved server-side against the current date. Populated on API responses; unset in the static catalog.

Available options:
active,
deprecated,
retired
Example:

"active"