SIsignalwire
AI Agents: Custom

List AI agent Addresses

Lists the resource addresses through which calls can reach one custom AI Agent in your SignalWire project. Use List AI agents to find the agent resources themselves; linked Dialogflow Agents expose their addresses separately.

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/{ai_agent_id}/addresses

Request

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

Path parameters

ai_agent_idstring uuid required

Universal Unique Identifier.

Unique ID of a AI Agent.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "name": "justice-league",
      "display_name": "Justice League",
      "cover_url": "https://coverurl.com",
      "preview_url": "https://previewurl.com",
      "locked": true,
      "channels": {
        "audio": "/external/resource_name?channel=audio"
      },
      "created_at": "2024-05-06T12:20:00Z",
      "type": "app"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/ai_agents/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=ai_agent",
    "first": "https://example.signalwire.com/api/fabric/resources/ai_agents/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=ai_agent",
    "next": "https://example.signalwire.com/api/fabric/resources/ai_agents/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?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/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=ai_agent"
  }
}

Changes

No operation changes found yet. Some revisions have not been checked.