Skip to content
supermemory-new
Get started
API Reference

Documents

Add document
client.documents.add(DocumentAddParams { content, containerTag, containerTags, 6 more } body, RequestOptionsoptions?): DocumentAddResponse { id, status }
POST/v3/documents
List documents
client.documents.list(DocumentListParams { containerTags, filepath, filters, 5 more } body, RequestOptionsoptions?): DocumentListResponse { memories, pagination }
POST/v3/documents/list
Update document
client.documents.update(stringid, DocumentUpdateParams { containerTag, containerTags, content, 5 more } body, RequestOptionsoptions?): DocumentUpdateResponse { id, status }
PATCH/v3/documents/{id}
Get document
client.documents.get(stringid, RequestOptionsoptions?): DocumentGetResponse { id, connectionId, content, 16 more }
GET/v3/documents/{id}
Delete document by ID or customId
client.documents.delete(stringid, RequestOptionsoptions?): void
DELETE/v3/documents/{id}
Bulk delete documents
client.documents.deleteBulk(DocumentDeleteBulkParams { containerTags, filepath, ids } body, RequestOptionsoptions?): DocumentDeleteBulkResponse { deletedCount, success, containerTags, errors }
DELETE/v3/documents/bulk
Upload a file
client.documents.uploadFile(DocumentUploadFileParams { file, containerTag, containerTags, 9 more } body, RequestOptionsoptions?): DocumentUploadFileResponse { id, status }
POST/v3/documents/file
Batch add documents
client.documents.batchAdd(DocumentBatchAddParams { documents, containerTag, containerTags, 6 more } body, RequestOptionsoptions?): DocumentBatchAddResponse { failed, results, success }
POST/v3/documents/batch
Get processing documents
client.documents.listProcessing(RequestOptionsoptions?): DocumentListProcessingResponse { documents, totalCount }
GET/v3/documents/processing
ModelsExpand Collapse
DocumentAddResponse { id, status }
id: string

Unique identifier of the document

status: string

Status of the document

DocumentListResponse { memories, pagination }

List of documents

memories: Array<Memory>
id: string

Unique identifier of the document.

minLength22
maxLength22
connectionId: string | null

Optional ID of connection the document was created from. This is useful for identifying the source of the document.

minLength22
maxLength22
createdAt: string

Creation timestamp

formatdatetime
customId: string | null

Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.

maxLength255
filepath: string | null
metadata: string | number | boolean | 2 more | null

Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.

One of the following:
string
number
boolean
Record<string, unknown>
Array<unknown>
status: "unknown" | "queued" | "extracting" | 5 more

Status of the document

One of the following:
"unknown"
"queued"
"extracting"
"chunking"
"embedding"
"indexing"
"done"
"failed"
summary: string | null

Summary of the document content

title: string | null

Title of the document

type: "text" | "pdf" | "tweet" | 10 more

Type of the document

One of the following:
"text"
"pdf"
"tweet"
"google_doc"
"google_slide"
"google_sheet"
"image"
"video"
"audio"
"notion_doc"
"webpage"
"onedrive"
"github_markdown"
updatedAt: string

Last update timestamp

formatdatetime
DeprecatedcontainerTags?: Array<string>

Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

content?: string

Content of the document (only included when includeContent=true)

url?: string | null

URL of the document

DocumentUpdateResponse { id, status }
id: string

Unique identifier of the document

status: string

Status of the document

DocumentGetResponse { id, connectionId, content, 16 more }

Document object

id: string

Unique identifier of the document.

minLength22
maxLength22
connectionId: string | null

Optional ID of connection the document was created from. This is useful for identifying the source of the document.

minLength22
maxLength22
content: string | null

The content to extract and process into a document. This can be a URL to a website, a PDF, an image, or a video.

Plaintext: Any plaintext format

URL: A URL to a website, PDF, image, or video

We automatically detect the content type from the url’s response format.

createdAt: string

Creation timestamp

formatdatetime
customId: string | null

Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.

maxLength255
dreamingStatus: "dreaming" | "done"
One of the following:
"dreaming"
"done"
filepath: string | null
metadata: string | number | boolean | 2 more | null

Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.

One of the following:
string
number
boolean
Record<string, unknown>
Array<unknown>
ogImage: string | null
raw: unknown

Raw content of the document

source: string | null

Source of the document

maxLength255
status: "unknown" | "queued" | "extracting" | 5 more

Status of the document

One of the following:
"unknown"
"queued"
"extracting"
"chunking"
"embedding"
"indexing"
"done"
"failed"
summary: string | null

Summary of the document content

taskType: "memory" | "superrag"

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

One of the following:
"memory"
"superrag"
title: string | null

Title of the document

type: "text" | "pdf" | "tweet" | 10 more

Type of the document

One of the following:
"text"
"pdf"
"tweet"
"google_doc"
"google_slide"
"google_sheet"
"image"
"video"
"audio"
"notion_doc"
"webpage"
"onedrive"
"github_markdown"
updatedAt: string

Last update timestamp

formatdatetime
DeprecatedcontainerTags?: Array<string>

Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

url?: string | null

URL of the document

DocumentDeleteBulkResponse { deletedCount, success, containerTags, errors }

Response for bulk document deletion

deletedCount: number

Number of documents successfully deleted

success: boolean

Whether the bulk deletion was successful

DeprecatedcontainerTags?: Array<string>

Container tags that were processed (only applicable when deleting by container tags)

errors?: Array<Error>

Array of errors for documents that couldn’t be deleted (only applicable when deleting by IDs)

id: string
error: string
DocumentUploadFileResponse { id, status }
id: string

Unique identifier of the document

status: string

Status of the document

DocumentBatchAddResponse { failed, results, success }
failed: number

Count of documents that failed to add

results: Array<Result>

Array of results for each document in the batch

id: string

Unique identifier of the document (empty string for failed items)

status: string

Status of the document (e.g. ‘done’, ‘queued’, ‘error’)

details?: string

Additional error details when status is ‘error’

error?: string

Error message when status is ‘error’

success: number

Count of documents successfully added

DocumentListProcessingResponse { documents, totalCount }

List of documents currently being processed

documents: Array<Document>
id: string

Unique identifier of the document.

minLength22
maxLength22
createdAt: string

Creation timestamp

formatdatetime
customId: string | null

Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.

maxLength255
metadata: string | number | boolean | 2 more | null

Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.

One of the following:
string
number
boolean
Record<string, unknown>
Array<unknown>
status: "unknown" | "queued" | "extracting" | 5 more

Status of the document

One of the following:
"unknown"
"queued"
"extracting"
"chunking"
"embedding"
"indexing"
"done"
"failed"
title: string | null

Title of the document

type: "text" | "pdf" | "tweet" | 10 more

Type of the document

One of the following:
"text"
"pdf"
"tweet"
"google_doc"
"google_slide"
"google_sheet"
"image"
"video"
"audio"
"notion_doc"
"webpage"
"onedrive"
"github_markdown"
updatedAt: string

Last update timestamp

formatdatetime
DeprecatedcontainerTags?: Array<string>

Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

totalCount: number

Total number of processing documents