Skip to main content
PUT
/
agents
/
{id}
Update an existing Agent
curl --request PUT \
  --url https://core.ravenna.ai/api/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "customPrompt": "<string>",
  "imageUrl": "<string>",
  "image": {
    "base64": "<string>",
    "fileName": "<string>"
  },
  "enabled": true,
  "respondOnMessage": "all-messages",
  "respondOnMention": true,
  "onlyRespondToRequests": true,
  "channelMessageBehavior": "all",
  "threadedMessageBehavior": "all",
  "autoClassify": true,
  "autoTag": true,
  "negativeFeedbackAutoCreate": true,
  "autoEscalate": true,
  "availableInDM": true,
  "tools": [
    "<string>"
  ],
  "queueIds": [
    "<string>"
  ],
  "kbIds": [
    "<string>"
  ],
  "requestTypeIds": [
    "<string>"
  ],
  "workflowIds": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "customPrompt": "<string>",
  "imageUrl": "<string>",
  "workspaceId": "<string>",
  "personalityId": "<string>",
  "enabled": true,
  "respondOnMessage": "<string>",
  "respondOnMention": true,
  "onlyRespondToRequests": true,
  "channelMessageBehavior": "<string>",
  "threadedMessageBehavior": "<string>",
  "autoClassify": true,
  "autoTag": true,
  "negativeFeedbackAutoCreate": true,
  "autoEscalate": true,
  "availableInDM": true,
  "tools": [
    "<string>"
  ],
  "workspace": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>"
  },
  "personality": {
    "id": "<string>",
    "workspaceId": "<string>",
    "persona": "<string>",
    "tone": "<string>",
    "emoji": "<string>",
    "length": "<string>",
    "greeting": "<string>",
    "branding": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "queues": [
    {
      "id": "<string>",
      "name": "<string>",
      "prefix": "<string>",
      "emoji": "<string>",
      "system": true,
      "requestTypes": [
        {
          "id": "<string>",
          "name": "<string>",
          "emoji": "<string>",
          "color": "<string>",
          "description": "<string>",
          "icon": "<string>"
        }
      ],
      "kBs": [
        {
          "id": "<string>",
          "name": "<string>",
          "system": true,
          "lastSyncTS": 123,
          "global": true,
          "_count": {
            "kBDocuments": 123
          }
        }
      ]
    }
  ],
  "kBs": [
    {
      "id": "<string>",
      "name": "<string>",
      "system": true,
      "lastSyncTS": 123,
      "global": true,
      "_count": {
        "kBDocuments": 123
      }
    }
  ],
  "requestTypes": [
    {
      "id": "<string>",
      "name": "<string>",
      "emoji": "<string>",
      "color": "<string>",
      "description": "<string>",
      "icon": "<string>",
      "aiExamples": "<string>",
      "customFields": [
        {
          "id": "<string>",
          "order": 123,
          "private": true,
          "required": true,
          "ticketField": "TITLE",
          "requestTypeId": "<string>",
          "customFieldId": "<string>",
          "customField": {
            "id": "<string>",
            "workspaceId": "<string>",
            "key": "<string>",
            "label": "<string>",
            "description": "<string>",
            "required": true,
            "system": true,
            "type": "TEXT",
            "config": "<any>",
            "options": [
              "<any>"
            ],
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "_count": {
              "requestTypeCustomField": 123
            }
          },
          "parentId": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ]
    }
  ],
  "workflows": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "state": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
Minimum length: 1
​
description
string
​
customPrompt
string | null
​
imageUrl
string<uri>
​
image
object
​
enabled
boolean
​
respondOnMessage
enum<string>
Available options:
all-messages,
channel-messages,
no-messages
​
respondOnMention
boolean
​
onlyRespondToRequests
boolean
​
channelMessageBehavior
enum<string>
Available options:
all,
requests,
mentions
​
threadedMessageBehavior
enum<string>
Available options:
all,
mentions
​
autoClassify
boolean
​
autoTag
boolean
​
negativeFeedbackAutoCreate
boolean
​
autoEscalate
boolean
​
availableInDM
boolean
​
tools
string[]
​
queueIds
string[]
​
kbIds
string[]
​
requestTypeIds
string[]
​
workflowIds
string[]

Response

​
id
string
required
​
name
string
required
​
description
string | null
required
​
customPrompt
string | null
required
​
imageUrl
string | null
required
​
workspaceId
string
required
​
personalityId
string | null
required
​
enabled
boolean
required
​
respondOnMessage
string
required
​
respondOnMention
boolean
required
​
onlyRespondToRequests
boolean
required
​
channelMessageBehavior
string
required
​
threadedMessageBehavior
string
required
​
autoClassify
boolean
required
​
autoTag
boolean
required
​
negativeFeedbackAutoCreate
boolean
required
​
autoEscalate
boolean
required
​
availableInDM
boolean
required
​
tools
string[]
required
​
workspace
object
required
​
personality
object | null
required
​
queues
object[]
required
​
kBs
object[]
required
​
requestTypes
object[]
required
​
workflows
object[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
deletedAt
string | null
required