Skip to main content
GET
Resolve a file_search citation link (302 redirect, or JSON with redirect=0)

Authorizations

Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

agentId
string
required
Maximum string length: 64

Query Parameters

knowledge_base_id
string
required

The file_search knowledge base the cited document belongs to.

Maximum string length: 128
Pattern: ^[a-zA-Z0-9_-]+$
document_id
string
required

The cited document id.

Maximum string length: 128
Pattern: ^[a-zA-Z0-9_-]+$
redirect
enum<string>

0 returns the resolved URL as JSON instead of redirecting to it.

Available options:
0

Response

Resolved URL, returned when redirect=0. Sent with Cache-Control: no-store.

url
string<uri>
required

Short-lived URL of the document, openable without credentials.

expires_at
integer | null

Unix seconds after which url stops working; resolve again after it.