Update AI Agent

PUT 
/resources/ai_agents/:id

Updates a AI Agent by ID.

Request

Path Parameters

id uuidrequired

The ID of the AI Agent

application/json

Body

required

contents string
name string

Responses

200

A AI Agent

application/json

Schema

Schema

id uuid
project_id uuid
display_name string
type string
created_at date-time
updated_at date-time

ai_agent

object

id uuid

A unique identifier for the AI Agent

contents string

display_name string

requests integer

The number of times this AI Agent has been executed

last_accessed_at date-time

The last time this AI Agent was executed

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Booking Assistant",
  "type": "ai_agent",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "ai_agent": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contents": "{ \"name\": \"Virtual Support Assistant\", \"contents\": { \"sections\": { \"main\": [ { \"ai\": { \"prompt\": { \"text\": \"Your name is John and you are a Customer Support virtual assistant. Begin by greeting the caller, then ask for...\" }, \"languages\": [ { \"code\": \"en-US\", \"voice\": \"gcloud.en-US-Standard-A\", \"name\": \"English (US)\" } ] } } ] } } }",
    "display_name": "Booking Assistant",
    "requests": 0,
    "last_accessed_at": "2024-01-02T00:00:00Z"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
}

Loading...