v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
AI Agents: Custom

Update AI agent

Updates an AI Agent by ID

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}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of an AI Agent.

Request body

global_dataSWMLCallingGlobalData

A key-value object for data that persists throughout an AI or sidecar session.

post_prompt_urlstring uri

The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of username:password@url.

agent_idstring uuid

Universal Unique Identifier.

namestring

Name of the 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.