POST
/
tools
/
mentions
curl --request POST \
  --url https://api.{environment}.corti.app/v2/tools/mentions \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "referenceTexts": [
    "<string>"
  ]
}'
{
  "properties": "<string>",
  "range": [
    123
  ],
  "time": [
    123
  ],
  "snippet": "<string>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "utteranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z"
}

Headers

Tenant-Name
string

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"copiloteu"

Body

application/json
query
string
required

The text-based query from the user.

referenceTexts
string[]
required

An array of reference texts where the mentions will be searched.

Response

200
application/json
Returns an array of mentions found in the reference texts.
properties
string

The type of mention (e.g., transcript, document).

range
integer[]

Character range for document type.

time
integer[]

Time range in seconds for transcript type.

snippet
string

Text snippet for the mention.

documentId
string

The document ID if applicable.

utteranceId
string

The utterance ID if applicable.

timestamp
string

The timestamp for transcript mentions.