Addresses3

AI Agents: Custom6

AI Agents: Dialogflow5

AI Chat1

Alias Addresses5

Call Flows8

Caller ID Name3

Calls1

Campaign Registry: Brands4

Campaign Registry: Campaigns4

Campaign Registry: Phone Number Assignments5

Chat Tokens1

Chunks3

Conference Logs1

Conference Rooms6

Conference Tokens3

cXML Applications5

cXML Scripts6

cXML Webhook6

Documents6

Domain Applications1

E911 Addresses7

Fax Logs2

FreeSWITCH Connector6

Imported Phone Numbers1

Message Logs2

Messages2

Multi-Factor Authentication3

Number Group Membership4

Number Groups5

Phone Number Addresses5

Phone Number Lookup1

Phone Numbers6

Phone Routes1

Project Tokens5

Projects6

PubSub Tokens1

Queue Members3

Queues5

Recordings3

Relay Application6

Resources3

Room Recordings4

Room Sessions5

Room Tokens1

Rooms6

Short Codes3

SIP Addresses5

SIP Credentials7

SIP Endpoints (Legacy)5

SIP Gateway6

SIP Profile2

Space4

Space Balance4

Space Billing10

Space Domain Applications5

Space Members8

Streams7

Subscriber SIP Credentials5

Subscriber Tokens5

Subscribers6

SWML Scripts6

SWML Webhook6

Verified Caller ID7

Video Conferences5

Video Logs2

Voice Logs3

WhatsApp Businesses1

WhatsApp Numbers2

WhatsApp Routes1

WhatsApp Templates5

Webhooks

AI Webhooks8

Calling Webhooks3

Messaging Webhooks3

AI Agents: Custom

Update AI agent

Changed on Aug 20, 2026

Updates how an existing custom AI Agent behaves in conversations. Use it for an agent configured directly in your SignalWire project; update a linked Dialogflow resource with Update Dialogflow agent.

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.

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

Request body

hintsstring[]

Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately.

See ai.hints in the SWML reference.

languagesobject[]

An array of JSON objects defining supported languages in the conversation. Mutually exclusive with multilingual: if both are set, multilingual is used and this array is ignored.

See ai.languages in the SWML reference.

paramsobject

A JSON object containing parameters as key-value pairs.

See ai.params in the SWML reference.

post_promptobject

The final set of instructions and configuration settings to send to the agent.

See ai.post_prompt in the SWML reference.

pronounceobject[]

An array of JSON objects to clarify the AI's pronunciation of words or expressions.

See ai.pronounce in the SWML reference.

promptobject

Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. The prompt establishes how the agent should interact with callers, what information it should gather, and how it should respond to various scenarios. It is recommended to write prompts using markdown formatting.

See ai.prompt in the SWML reference.

SWAIGobject

An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.

See ai.SWAIG in the SWML reference.

namestring

Name of the AI Agent.

Example request

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

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

Aug 20, 2026173ff877e9cd Revision changes
- breaking
  request property / list-of-types was narrowed by removing types object from media type application/json
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- 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
Aug 20, 2026e79dcc8b2150 Revision changes
- breaking
  removed from the / request property anyOf list
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  added 'unevaluatedProperties' constraint to the request property
- breaking
  added 'unevaluatedProperties' constraint to the request property
- breaking
  added 'unevaluatedProperties' constraint to the request property
- breaking
  added 'unevaluatedProperties' constraint to the request property
- breaking
  added 'unevaluatedProperties' constraint to the request property
- breaking
  added 'unevaluatedProperties' constraint to the request property
- 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 from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- 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
  added subschema #2 to the / request property anyOf list
- 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.

Operation history (35 revisions)

Update AI agent

Permissions

Request

Path parameters

Request body

Example request

Response 200OK

Example response

Changes

Response