Documents

Upload documents

Upload one or more documents to the project. Send the files as multipart/form-data under the files field (repeat the field for multiple files). Successful uploads return 202 Accepted: the accepted document rows are created immediately and returned in documents, while parsing/conversion continues in the background. Excel workbooks produce one document per accepted sheet; email uploads can also produce attachment documents.

post/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

Request body multipart/form-data

filesstring[] required

One or more files to upload. Repeat the files field once per file (standard multipart/form-data multi-file upload). Supported types: PDF, Word, Excel, PPT, Image, Email (.eml), and UTF-8 plain text (.txt) or Markdown (.md, .markdown). Text and Markdown are paginated as written, without Markdown formatting; a text file that cannot be read (for example not UTF-8 or empty) is created with status Failed.

skip_sheetsstring

Optional JSON-encoded object of the form {"filename.xlsx": [{"name": "Sheet1", "estimatedPages": 1500}, ...]} listing Excel sheets the caller chose not to upload because they exceeded size limits. Used for logging and quota accounting only; omit if not applicable.

Response

Files accepted; document rows created; parsing/conversion queued or started.

excel_countinteger required

Number of top-level Excel files accepted for asynchronous sheet-by-sheet processing. 0 when no top-level Excel files were accepted.

Changes

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