Resources

List Resources

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

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

Changed in 35 of the 137 revisions of this API.2107335010961

  • 173ff877e9cd31See the full diff
    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/global_data from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/multilingual from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/post_prompt_url from the response with the 200 status

      response-optional-property-removed

    • 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

      response-property-list-of-types-narrowed

  • e79dcc8b2150141220See the full diff
    • the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #1: Calling Script]/contents response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #2: Messaging Script]/contents response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/SWAIG response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/global_data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/multilingual response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/params response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/post_prompt response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/prompt response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the data/items/oneOf[subschema #2: Call Flow]/call_flow/allOf[CallFlow]/relayml response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • removed the required property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/code from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/name from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/voice from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/pronounce/items/replace from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/pronounce/items/with from the response with the 200 status

      response-required-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/auto_emotion from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/auto_speed from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/engine from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/fillers from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/function_fillers from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/listen_language from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/model from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/params from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/pronounce from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/speech_fillers from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/languages/items/turn_fillers from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/pronounce/items/ignore_case from the response with the 200 status

      response-optional-property-removed

    • removed SWML.Calling.AIParams from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/params response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.AIPostPrompt from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/post_prompt response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.AIPrompt from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/prompt response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.GlobalData from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/global_data response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.Multilingual from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/multilingual response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.SWAIG from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/SWAIG response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.SWMLObject from the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #1: Calling Script]/contents response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Calling.SWMLObject from the data/items/oneOf[subschema #2: Call Flow]/call_flow/allOf[CallFlow]/relayml response property allOf list for the response status 200

      response-property-all-of-removed

    • removed SWML.Messaging.SWMLObject from the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #2: Messaging Script]/contents response property allOf list for the response status 200

      response-property-all-of-removed

    • added subschema #2 to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/hints/items/ response property anyOf list for the response status 200

      response-property-any-of-added

    • removed SWML.Calling.Hint from the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/hints/items/ response property anyOf list for the response status 200

      response-property-any-of-removed

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #1: Calling Script]/contents response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #13: SWML Script]/swml_script/allOf[subschema #1: SWML Script]/oneOf[subschema #2: Messaging Script]/contents response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/SWAIG response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/global_data response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/multilingual response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/params response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/post_prompt response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #1: AI Agent]/ai_agent/allOf[subschema #1: AI Agent]/prompt response property for the status 200

      response-property-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the data/items/oneOf[subschema #2: Call Flow]/call_flow/allOf[CallFlow]/relayml response property for the status 200

      response-property-unevaluated-properties-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 137 revisions, 3 have a changelog that could not be searched.