API Reference
API Reference

Get Bridge Phrases

Fetch a given bridge phrases config.

GET/api/v1/bridge_phrases/{bridge_phrases_id}

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

Path parameters

bridge_phrases_id integer path required

Responses

200Successful Response

application/json

response BridgePhrasesResponse required
9 fields
namestringrequired

The name of the bridge phrases config.

descriptionstring | nulloptional

Description of the bridge phrases config.

configBridgePhrasesConfigPayloadoptional

Default phrases plus per-tool overrides.

4 fields
phraseslib__database__dao__organization__bridge_phrases_dao__BridgePhraseMessagesoptional

Default bridge phrases (used when no tool-specific entry matches).

2 fields
messagesstring[]optional

Ordered bridge phrases for this scope.

Item schema
itemsstringrequired
localizedobjectoptional

Per-language overrides keyed by BCP-47 tag (e.g. "es-US").

1 field
{key}LocalizedBridgePhrasesoptional

Per-language bridge phrase overrides (no further nesting).

1 field
messagesstring[]optional

Bridge phrases for this language.

Item schema
itemsstringrequired
toolsToolBridgePhraseConfig[]optional

Per-tool phrase overrides.

Item schema
itemsToolBridgePhraseConfigrequired

Per-tool bridge phrase override entry.

2 fields
tool_namestringrequired

Name of the tool these phrases override.

phraseslib__database__dao__organization__bridge_phrases_dao__BridgePhraseMessagesreference defined above

Phrase messages for this tool.

smart_turn_timeout_secondsnumber | nulloptional

Seconds of caller silence before injecting the first bridge phrase. Defaults to 2.75s when omitted on write.

Default 2.75Minimum 0.25Maximum 30
randomize_bridge_phrasesbooleanoptional

Whether to randomize the order of bridge phrases. When true, the order of the bridge phrases is randomized for each call.

Default false
is_defaultbooleanoptional

Whether this config is currently marked as the default for its suborg.

Default false
idintegerrequired

The ID of the bridge phrases config to update.

edit_commentsstring | nulloptional

Comments for the most recent edit.

agents_infoBridgePhrasesAgentInfo[] | nulloptional

IDs and names of the agents linked to this bridge phrases config.

Item schema
itemsBridgePhrasesAgentInforequired

Information about an agent linked to a bridge phrases config.

2 fields
idintegerrequired

The ID of the agent.

namestringrequired

The name of the agent.

updated_atstring (date-time)required

Timestamp of the last update.

last_updated_bystringrequired

Email of the user who last updated this config.

Response example
{
  "name": "string",
  "description": "string",
  "config": {
    "phrases": {
      "messages": [
        "string"
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "tool_name": "string",
        "phrases": null
      }
    ],
    "smart_turn_timeout_seconds": 2.75,
    "randomize_bridge_phrases": false
  },
  "is_default": false,
  "id": 0,
  "edit_comments": "string",
  "agents_info": "string",
  "updated_at": "string",
  "last_updated_by": "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"
    }
  ]
}