API reference · 1 endpoint
Files
Upload files for OCR, parsing, and retention as memories.
POST
/v1/default/namespaces/{namespace_id}/files/retainConvert files to memories
Upload files (PDF, DOCX, etc.), convert them to markdown, and retain as memories.
This endpoint handles file upload, conversion, and memory creation in a single operation.
Features:
- Supports PDF, DOCX, PPTX, XLSX, images (with OCR), audio (with transcription)
- Automatic file-to-markdown conversion using pluggable parsers
- Files stored in object storage (PostgreSQL by default, S3 for production)
- Each file becomes a separate document with optional metadata/tags
- Always processes asynchronously — returns operation IDs immediately
The system automatically:
- Stores uploaded files in object storage
- Converts files to markdown
- Creates document records with file metadata
- Extracts facts and creates memory units (same as regular retain)
Use the operations endpoint to monitor progress.
Request format: multipart/form-data with:
files: One or more files to uploadrequest: JSON string with FileRetainRequest model
Parser selection:
- Set
parserin the request body to override the server default for all files. - Set
parserinside afiles_metadataentry for per-file control. - Pass a list (e.g.
['iris', 'markitdown']) to define an ordered fallback chain — each parser is tried in sequence until one succeeds. - Falls back to the server default (
ILLUMINA_API_FILE_PARSER) if not specified. - Only parsers enabled on the server may be requested; others return HTTP 400.
Parameters
namespace_idstringpathrequiredRequest body · multipart/form-data
filesstring (binary)[]requiredFiles to upload and convert
requeststringrequiredJSON string with FileRetainRequest model