Documents

List documents

All documents in the project, ordered by upload time (most recent first). Optionally filter to documents carrying a specific tag by supplying both tag_key and tag_value.

get/projects/{project_id}/documents/

Request

Base URL
https://api.parsewise.ai/api/v1
Auth
API key in header X-API-Key

Path parameters

project_idstring uuid required

Query parameters

tag_keystring

Tag key to filter by. Must be supplied together with tag_value.

tag_valuestring

Tag value to filter by. Must be supplied together with tag_key.

Response

idstring uuid required

Stable identifier for the document (UUID).

project_idstring uuid required

Identifier of the project this document belongs to.

file_urlstring uri required

URL for downloading the original uploaded file.

uploaded_atstring date-time required

Timestamp when the document was uploaded.

PDF - PDF
Audio - Audio
Image - Image
Text - Text
Excel - Excel
PPT - PPT
Word Document - Word Document
Website - Website
Email - Email

page_countinteger

Number of pages detected after parsing. 0 until parsing completes.

versioninteger

Version number, incremented each time the document is reprocessed.

summarystring

AI-generated short summary of the document contents.

metadatastring

Free-form metadata extracted from the document by the parser. Format is parser-dependent (often a JSON string, sometimes plain text); may be empty.

status'Pending' | 'Processed' | 'Failed' required

Pending - Pending
Processed - Processed
Failed - Failed

uses_agentic_extractionboolean

True when the document is parsed using the agentic (AI-assisted) parser, false when it is parsed by the standard parser.

last_parsed_atstring date-time nullable

Timestamp of the most recent successful parse, or null if it has never been parsed.

archive_requested_atstring date-time nullable

Timestamp when archival was requested for this document, or null. A non-null value means the document is queued to be moved into an archived project and will disappear from this project once archival completes.

file_namestring required

Original filename of the uploaded document.

Changes

No recorded changes to this operation across all 1 revision of this API.