Upload single document file
Upload a single document file with metadata for processing.
Allowed formats are:
- Images: .jpeg, .jpg, .png, .tiff (.tif)
- PDFs: .pdf
The API accepts a single file with optional JSON metadata. A DocumentId is pre-assigned and returned immediately.
Note: This endpoint does not use splitter functionality.
**DEPRECATED:** This endpoint will be removed. Use the batch upload endpoint (`/upload-direct`) instead, which supports single or multiple files.
Authentication
x-api-keystring
API key authentication for programmatic access. Used by server-to-server integrations and API clients.
OR
x-access-tokenstring
Access token authentication for web users. Used by browser-based applications and authenticated user sessions.
Request
Upload single document with optional metadata
file
Single binary document file to upload via multipart/form-data.
**Supported formats:**
- **Images:** .jpeg, .jpg, .png, .tiff (.tif)
- **PDFs:** .pdf
**Note:** Upload actual binary file data, not file path or string. Use standard HTML file input or equivalent HTTP multipart upload.
**Filename Encoding Limitation:** Due to RFC 2388 multipart/form-data specification, filenames are limited to Latin-1 (ISO-8859-1) character encoding. Non-ASCII characters (e.g., UTF-8 Unicode) in filenames will appear corrupted. For best compatibility, use ASCII-safe characters in filenames or implement client-side filename encoding.
info
JSON object containing file metadata
Response
Document uploaded successfully with pre-assigned DocumentId
accountId
Account ID
environmentId
Environment ID
importId
Import ID for tracking the upload process
fileId
File ID for the uploaded file
filename
Original filename
documentIdDeprecated
Pre-assigned Document ID. DEPRECATED: This field will be removed. Instead, use webhooks to receive processing notifications, then retrieve documentIds from the file details endpoint.
