Resources

List Resources

Changed on

Lists every supported Fabric resource in your SignalWire project, regardless of type. Use it for project-wide inventory or when you do not yet know whether an ID belongs to an AI Agent, script, SIP resource, or another resource type. Use a type-specific collection such as SWML Scripts or SIP Credentials to create resources or work with their full configuration.

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

Request

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

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "display_name": "My Resource",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "type": "ai_agent",
      "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://devspace.signalwire.com/api/fabric/resources?page_number=0&page_size=50",
    "first": "https://devspace.signalwire.com/api/fabric/resources?page_size=50",
    "next": "https://devspace.signalwire.com/api/fabric/resources?page_number=1&page_size=50&page_token=PA0f2b7869-304c-45ac-8863-3455ccb34cdc",
    "prev": "https://devspace.signalwire.com/api/fabric/resources?page_number=0&page_size=50&page_token=PA0f2b7869-304c-45ac-8863-3455ccb34cdc"
  }
}

Changes

  • 3ce00e9f8aa1Revision changes
    • breaking

      added to the / response property oneOf list for the response status

  • 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/oneOf[subschema #1: AI Agent]/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

Some revisions have not been checked yet.