Upload a file

Upload a file to be processed

POST /v3/documents/file

Upload a file

JavaScript

const form = new FormData();
form.append('file', '{}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.supermemory.ai/v3/documents/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "status": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

File upload form data schema

file · file · required

File to upload and process

containerTag · string

Optional container tag (e.g., 'user_123'). Use this for a single tag.

Example:

"user_123"

containerTags · string · deprecated

Optional container tags. Can be either a JSON string of an array (e.g., '["user_123", "project_123"]') or a single string (e.g., 'user_123'). Single strings will be automatically converted to an array.

Example:

"[\"user_123\", \"project_123\"]"

fileType · string

Optional file type override to force specific processing behavior. Valid values: text, pdf, tweet, google_doc, google_slide, google_sheet, image, video, notion_doc, webpage, onedrive

Example:

"image"

mimeType · string

Required when fileType is 'image' or 'video'. Specifies the exact MIME type to use (e.g., 'image/png', 'image/jpeg', 'video/mp4', 'video/webm')

metadata · string

Optional metadata for the document as a JSON string. This is used to store additional information about the document. Keys must be strings and values can be strings, numbers, or booleans.

Example:

"{\"category\": \"technology\", \"isPublic\": true, \"readingTime\": 5}"

filepath · string

Optional file path for the uploaded file (e.g., '/documents/reports/file.pdf'). Used by supermemoryfs to map documents to filesystem paths.

Example:

"/documents/reports/file.pdf"

useAdvancedProcessing · string · deprecated

DEPRECATED: This field is no longer used. Advanced PDF processing is now automatic with our hybrid Mistral OCR + Gemini pipeline. This parameter will be accepted but ignored for backwards compatibility.

Example:

"true"

taskType · enum<string>

Task type: "memory" (default) for full context layer with SuperRAG built in, "superrag" for managed RAG as a service.

Available options: memory, superrag

Example:

"memory"

Response

200

application/json

Successfully uploaded file

id · string · required

Unique identifier of the document

status · string · required

Status of the document