Documents
Add document
List documents
Update document
Get document
Delete document by ID or customId
Bulk delete documents
Upload a file
Batch add documents
Get processing documents
ModelsExpand Collapse
DocumentListResponse object { memories, pagination } List of documents
List of documents
memories: array of object { id, connectionId, createdAt, 11 more }
Optional ID of connection the document was created from. This is useful for identifying the source of the document.
Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.
metadata: string or number or boolean or 2 moreOptional 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.
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.
DocumentGetResponse object { id, connectionId, content, 16 more } Document object
Document object
Optional ID of connection the document was created from. This is useful for identifying the source of the document.
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.
Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.
metadata: string or number or boolean or 2 moreOptional 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.
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.
taskType: "memory" or "superrag"Task type: “memory” (default) for full context layer with SuperRAG built in, “superrag” for managed RAG as a service.
Task type: “memory” (default) for full context layer with SuperRAG built in, “superrag” for managed RAG as a service.
DocumentListProcessingResponse object { documents, totalCount } List of documents currently being processed
List of documents currently being processed
documents: array of object { id, createdAt, customId, 6 more }
Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.
metadata: string or number or boolean or 2 moreOptional 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.
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.