Skip to main content
GET
/
tickets
/
semantic-search
Search for semantically similar tickets
curl --request GET \
  --url https://core.ravenna.ai/api/tickets/semantic-search \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "publishedAt": "<string>",
      "assignedAt": "<string>",
      "assigneeId": "<string>",
      "authorId": "<string>",
      "shortId": "<string>",
      "code": "<string>",
      "description": "<string>",
      "dueAt": "<string>",
      "id": "<string>",
      "number": 123,
      "priority": "URGENT",
      "published": true,
      "queue": {
        "id": "<string>",
        "prefix": "<string>",
        "emoji": "<string>",
        "workspaceId": "<string>",
        "name": "<string>",
        "workspace": {
          "slug": "<string>"
        }
      },
      "status": {
        "id": "<string>",
        "label": "<string>",
        "order": 123,
        "system": true,
        "statusGroupId": "<string>",
        "statusGroup": {
          "id": "<string>",
          "label": "<string>",
          "workspaceId": "<string>"
        },
        "requestTypes": [
          {
            "id": "<string>",
            "requestTypeId": "<string>"
          }
        ],
        "createdAt": "<string>",
        "updatedAt": "<string>"
      },
      "queueId": "<string>",
      "requesterId": "<string>",
      "requestType": {
        "id": "<string>",
        "name": "<string>",
        "isPrivate": true
      },
      "source": "WEB",
      "statusId": "<string>",
      "title": "<string>",
      "requestTypeId": "<string>",
      "disableAIResponse": true,
      "parentId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "snoozeUntil": "<string>",
      "approvedAt": "<string>",
      "private": true,
      "declinedAt": "<string>",
      "startAt": "<string>",
      "respondedAt": "<string>",
      "resolvedAt": "<string>",
      "closedAt": "<string>",
      "archivedAt": "<string>",
      "slackChannelId": "<string>",
      "assignedAIAgent": "<string>",
      "approvers": [
        {
          "id": "<string>"
        }
      ],
      "csat": [
        {
          "score": 123,
          "feedback": "<string>"
        }
      ],
      "parent": {
        "number": 123,
        "queue": {
          "prefix": "<string>"
        }
      },
      "children": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "number": 123,
          "statusId": "<string>",
          "legacyStatus": "OPEN"
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "totalCount": 123,
  "nextCursor": "<string>",
  "responseType": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Query Parameters

​
query
string
required
Minimum length: 1
​
limit
number
default:5
Required range: 1 <= x <= 20
​
excludeTicketId
string
​
provider
enum<string>
default:openai
Available options:
openai,
gemini,
cohere

Response

Successful response

  • Option 1
  • Option 2
​
items
object[]
required
​
totalCount
number
required
​
responseType
string
required
Allowed value: "thin"
​
nextCursor
string | null
⌘I