Skip to content
Catalyzed Docs
Create Account Sign In

Resolve citations to displayable data

POST
/citations/resolve

Transform raw citation pointers into displayable data with file metadata, location information, and cited text. Maximum 100 citations per request. If any citation fails to resolve, the entire request fails with a 500 error.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
teamId
required

Team ID for authorization context

string
citations
required

Array of citations to resolve

Array
>= 1 items <= 100 items
One of:
object
type
required
string
Allowed values: file
fileId
required

A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Citations resolved successfully

object
resolvedCitations
required

Array of resolved citations with file info, location, and cited text

Array
One of:
object
type
required
string
Allowed values: file
original
required
object
type
required
string
Allowed values: file
fileId
required

A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)

string
file
required
object
fileId
required
string
fileName
required
string
mimeType
required
string

400

Section titled “400 ”

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

401

Section titled “401 ”

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

403

Section titled “403 ”

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

500

Section titled “500 ”

Internal server error - one or more citations failed to resolve