Skip to main content
GET
Retrieve Document

Authorizations

PersoPlatform-APIKey
string
header
required

Path Parameters

document_id
string
required

Response

document_id
string
required
read-only
title
string
required
Maximum string length: 100
file
string<uri>
required

Source document file (PDF, DOCX, or TXT) to ingest as a knowledge base.

Pattern: (?:xls|xlsx|csv)$
processed
boolean
required
read-only
processed_v2
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string
search_count
integer

Number of search results to return per query (default depends on model).

Required range: -2147483648 <= x <= 2147483647
ef_search
integer | null

HNSW ef_search parameter for the vector index (1-500). Higher = more accurate, slower.

Required range: 1 <= x <= 500