List AI agents

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/ai_agents

GET

/api/fabric/resources/ai_agents

curl https://{your_space_name}.signalwire.com/api/fabric/resources/ai_agents \
     -u "<project_id>:<api_token>"

{
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Support Assistant",
      "type": "ai_agent",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:25:00Z",
      "ai_agent": {
        "prompt": {
          "text": "You are a helpful customer support assistant."
        },
        "agent_id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
        "name": "Support Assistant"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50"
  }
}

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.

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](/docs/apis/rest/ai-agents/ai-agents-dialogflow/list-dialogflow-agents) for linked Dialogflow integrations, or [Call Flows](/docs/apis/rest/call-flows/list-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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Response

The request has succeeded.

datalist of objects

An array of objects containing the list of AI Agent data.

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error