Skip to main content
DELETE
/
agents
/
bulk
Bulk delete agents
curl --request DELETE \
  --url https://core.ravenna.ai/api/agents/bulk \
  --header 'x-ravenna-api-token: <api-key>'
[
  {
    "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

Query Parameters

​
ids
string[]
required
Required array length: 1 - 100 elements

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