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.

On this page

HTTP request 

GET https://api.parsewise.ai/api/v1/projects/{project_id}/documents/

URI Parameters

Name In Required Type Description
project_id path Yes string (uuid)  
tag_key query No string Tag key to filter by. Must be supplied together with tag_value.
tag_value query No string Tag value to filter by. Must be supplied together with tag_key.

Request Header

Name Required Type Description
X-API-Key Yes string API key with the pw_live_ prefix. See Authentication.

Responses

Status Type Description
200 array<Document> —

Security

  • ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example 

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

project_id = "<uuid>"

params = {
    # "tag_key": "...",  # Tag key to filter by
    # "tag_value": "...",  # Tag value to filter by
}

resp = requests.get(
    f"{BASE_URL}/projects/{project_id}/documents/",
    headers={"X-API-Key": API_KEY},
    params=params,
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

Document

Name Required Type Description
id Yes string (uuid) Stable identifier for the document (UUID).
project_id Yes string (uuid) Identifier of the project this document belongs to.
file_url Yes string (uri) URL for downloading the original uploaded file.
uploaded_at Yes string (date-time) Timestamp when the document was uploaded.
type Yes TypeEnum Detected document type, inferred from the file extension at upload time.
page_count No integer Number of pages detected after parsing. 0 until parsing completes.
version No integer Version number, incremented each time the document is reprocessed.
summary No string AI-generated short summary of the document contents.
metadata No string 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 Yes Status61fEnum Lifecycle status. Pending while the document is being parsed; Processed once parsing has completed; Failed if parsing cannot complete.
uses_agentic_extraction No boolean True when the document is parsed using the agentic (AI-assisted) parser, false when it is parsed by the standard parser.
last_parsed_at No string (date-time) (nullable) Timestamp of the most recent successful parse, or null if it has never been parsed.
archive_requested_at No string (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.
tags Yes array<object> Key/value tags applied to the document.
file_name Yes string Original filename of the uploaded document.

Status61fEnum

Type: string. One of:

  • Pending
  • Processed
  • Failed

TypeEnum

Type: string. One of:

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