Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Body

application/json
document
object
required

The PDF document to ingest. Must contain exactly one content source (url, base64 or file) and may include a filename.

is_active
boolean

Whether the document chunks are active immediately. Defaults to false — the entries stay inactive until approved.

Example:

false

Response

The processing result for the uploaded document

file_name
string

Filename the document was stored under

Example:

"product-faq.pdf"

document_id
string

Id assigned to the uploaded document. Use it with the GET/DELETE /knowledge-base/document/{document_id} routes to fetch or delete the document and its chunks.

Example:

"00000000-0000-0000-0000-000000000000"

file_path
string

Storage path of the uploaded PDF in the org assets bucket

Example:

"org-assets/00000000-0000-0000-0000-000000000000/ai_assets/documents/00000000-0000-0000-0000-000000000000/product-faq.pdf"

chunks_count
integer

Number of knowledge-base entries (chunks) extracted from the document

Example:

12