API Reference
API Reference

Get Available Agent Stt Providers

Get the speech-to-text providers available to agents.

Each provider's status is resolved against the current date. Retired providers are omitted unless they match selected_provider, so an agent still saved on a retired provider can render it as a locked field.

GET/api/v1/agents/stt/available

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_provider string | null query optional

Responses

200Successful Response

application/json

response SupportedSttProvider[] required
Item schema
itemsSupportedSttProviderrequired

An STT provider offered to agents, with its resolved deprecation lifecycle.

7 fields
providerstringrequired

Speech-to-text provider value, as stored on the agent.

display_namestringrequired

Human-readable name of the provider.

deprecatedbooleanoptional

Whether the provider is in the deprecation warning window.

Default false
sunset_datestring (date) | nulloptional

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

removedbooleanoptional

Whether the provider is force-retired regardless of sunset_date.

Default false
fallbackstring | nulloptional

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

statusenum<string> | nulloptional

Effective lifecycle status, resolved server-side against the current date.

Allowed values ["active","deprecated","retired"]
Response example
[
  {
    "provider": "string",
    "display_name": "string",
    "deprecated": false,
    "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"
    }
  ]
}