Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key or UI session JWT passed as a Bearer token.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Path Parameters

id
string
required

Response

Successful Response

id
string
required

Unique identifier of the referenced source document.

reference_count
integer
required

Number of times the source was referenced in the query's output.

documentId
string | null

Document id, same as id when present.

filename
string | null

Original filename of the source, if available.

title
string | null

Title of the source, if available.

summary
string | null

Summary of the source, if available.

metadata
Metadata · object | null

Additional metadata of the source, if available.

url
string
default:""

URL to preview the source.

page
integer | null

1-based page number when known.

chunkId
string | null

Chunk id when known.

snippet
string | null

Retrieved passage snippet.

cited
boolean
default:false

True when the assistant answer cited this source.