AI Agents: Custom

List AI agents

Changed on

Lists the custom AI Agents in your SignalWire project. Each agent is a reusable Fabric resource that defines a conversational call experience and can be reached through resource addresses or assigned as a call handler. Use Dialogflow Agents for linked Dialogflow integrations, or Call Flows for visual, deterministic call logic.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

get/api/fabric/resources/ai_agents

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/ai_agents
  • Auth
    HTTP basic

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "display_name": "Booking Assistant",
      "type": "ai_agent",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "ai_agent": {
        "hints": [
          "pizza",
          "pepperoni"
        ],
        "languages": [
          {
            "name": "English",
            "code": "en-US",
            "voice": "rime.spore"
          }
        ],
        "params": {
          "ai_model": "gpt-4o-mini",
          "wait_for_user": true
        },
        "post_prompt": {
          "text": "Summarize the conversation and provide any follow-up action items."
        },
        "pronounce": [
          {
            "replace": "SWML",
            "with": "swim-el",
            "ignore_case": true
          }
        ],
        "prompt": {
          "text": "You are a helpful customer support assistant."
        },
        "SWAIG": {
          "native_functions": [
            "check_time"
          ]
        },
        "name": "My AI Agent"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&type=ai_agent",
    "first": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&type=ai_agent",
    "next": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=ai_agent",
    "prev": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=ai_agent"
  }
}

Changes

  • 173ff877e9cdRevision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      response property data/items/ai_agent/allOf[subschema #1: AI Agent]/hints/items/ list-of-types was narrowed by removing types object from media type application/json of response 200

  • e79dcc8b2150Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      added subschema #2 to the ///// response property anyOf list for the response status

    • info

      removed from the ///// response property anyOf list for the response status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

Some revisions have not been checked yet.