API Reference
API Reference

Get Supported Llm Configs

Get supported LLM configs.

Each config's status is resolved against the current date. Retired models are omitted unless they match selected_model, so a saved config still referencing a retired model can render it as a locked field.

GET/api/v1/prompts/llms/supported

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

selected_model string | null query optional

Responses

200Successful Response

application/json

response SupportedLlm[] required
Item schema
itemsSupportedLlmrequired

LLM config option that can be used on a prompt.

10 fields
providerenum<string>optional

Provider of the LLM model.

Allowed values ["anthropic","azure_openai","google","openai"]Default azure_openai
modelstringoptional

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

Default gpt-4o
display_namestringrequired

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

versionstring | nulloptional

Deprecated model version retained for backward compatibility.

api_versionstring | nulloptional

Version of the provider's API.

deprecatedbooleanrequired

Whether the model is in the deprecation warning window.

sunset_datestring (date) | nulloptional

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

removedbooleanoptional

Whether the model is force-retired regardless of sunset_date.

Default false
fallbackstring | nulloptional

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

statusenum<string> | nulloptional

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

Allowed values ["active","deprecated","retired"]
Response example
[
  {
    "provider": "azure_openai",
    "model": "gpt-4o",
    "display_name": "string",
    "version": "string",
    "api_version": "string",
    "deprecated": true,
    "sunset_date": "string",
    "removed": false,
    "fallback": "string",
    "status": "string"
  }
]
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}