API Reference
API Reference

List Bridge Phrases

Fetch bridge phrases configs.

GET/api/v1/bridge_phrases/

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

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required

Names of bridge phrases fields supported for filtering/sorting on list endpoint.

Allowed values ["name","description","updated_at","last_updated_by"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["name","description","updated_at","last_updated_by"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required

Names of bridge phrases fields supported for filtering/sorting on list endpoint.

Allowed values ["name","description","updated_at","last_updated_by"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_BridgePhrasesResponse_ required
5 fields
itemsBridgePhrasesResponse[]required

List of items returned from the query

Item schema
itemsBridgePhrasesResponserequired

Response model for bridge phrases operations.

A bridge phrases config is a named, sub-org-scoped collection of default bridge phrases plus optional per-tool and per-language overrides that can be linked to an agent. For more information, see Console docs.

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.

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "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"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "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"
    }
  ]
}