AI Agents: Custom

Get AI agent

Changed on

Retrieves one custom AI Agent from your SignalWire project. Use it to review an agent that is configured directly in SignalWire; use List AI agents to find agents, or Get Dialogflow agent for a linked Dialogflow resource.

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/{id}

Request

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

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of an AI Agent.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the AIAgent Fabric Resource

type'ai_agent' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "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"
  }
}

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 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.