Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://core.ravenna.ai/api/agents \
  --header 'x-ravenna-api-token: <api-key>'
{
  "nextCursor": "<string>",
  "totalCount": 123,
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "imageUrl": "<string>",
      "workspaceId": "<string>",
      "personalityId": "<string>",
      "enabled": true,
      "respondOnMessage": "<string>",
      "respondOnMention": true,
      "autoClassify": true,
      "autoTag": true,
      "negativeFeedbackAutoCreate": true,
      "availableInDM": true,
      "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>"
      },
      "slackChannels": [
        {
          "id": "<string>",
          "channelName": "<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>"
            }
          ]
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}

Authorizations

​
x-ravenna-api-token
string
header
required

Query Parameters

​
skip
number | null
Required range: x >= 1
​
offset
number | null
Required range: x >= 0
​
cursor
string | null
​
limit
number | null
default:100
Required range: 1 <= x <= 10000
​
set
string | null
​
sortBy
string | null
​
sortDirection
enum<string> | null
Available options:
asc,
desc
​
groupBy
string | null
​
groupDirection
enum<string> | null
Available options:
asc,
desc
​
workspaceId
string | null

Response

Successful response

​
items
object[]
required
​
nextCursor
string
​
totalCount
number
⌘I