Skip to main content
Manage documents after ingestion using the SDK.

List Documents

Retrieve paginated documents with filtering.
const documents = await client.documents.list({
  limit: 10,
  containerTags: ["user_123"]
});

documents.memories.forEach(d => {
  console.log(d.id, d.title, d.status);
});
Response:
{
  "memories": [
    {
      "id": "doc_abc123",
      "title": "Meeting notes",
      "status": "done",
      "type": "text",
      "createdAt": "2024-01-15T10:30:00Z",
      "containerTags": ["user_123"],
      "metadata": { "source": "slack" }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 3,
    "totalItems": 25
  }
}

Parameters

ParameterTypeDefaultDescription
limitnumber50Items per page (max 200)
pagenumber1Page number
containerTagsstring[]Filter by tags
sortstringcreatedAtSort by createdAt or updatedAt
orderstringdescdesc (newest) or asc (oldest)
async function getAllDocuments(containerTag: string) {
  const all = [];
  let page = 1;

  while (true) {
    const { memories, pagination } = await client.documents.list({
      containerTags: [containerTag],
      limit: 100,
      page
    });

    all.push(...memories);
    if (page >= pagination.totalPages) break;
    page++;
  }

  return all;
}
const documents = await client.documents.list({
  containerTags: ["user_123"],
  filters: {
    AND: [
      { key: "status", value: "reviewed", negate: false },
      { key: "priority", value: "high", negate: false }
    ]
  }
});

Get Document

Get a specific document with its processing status.
const doc = await client.documents.get("doc_abc123");

console.log(doc.status);  // "queued" | "processing" | "done" | "failed"
console.log(doc.content);

Processing Status

StatusDescription
queuedWaiting to process
extractingExtracting content (OCR, transcription)
chunkingBreaking into searchable pieces
embeddingCreating vector representations
doneReady for search
failedProcessing failed
async function waitForProcessing(docId: string) {
  while (true) {
    const doc = await client.documents.get(docId);

    if (doc.status === "done") return doc;
    if (doc.status === "failed") throw new Error("Processing failed");

    await new Promise(r => setTimeout(r, 2000));
  }
}

Update Document

Update a document’s content or metadata. Triggers reprocessing.
await client.documents.update("doc_abc123", {
  content: "Updated content here",
  metadata: { version: 2, reviewed: true }
});

Delete Documents

Permanently remove documents.
// Single delete
await client.documents.delete("doc_abc123");

// Bulk delete by IDs
await client.documents.deleteBulk({
  ids: ["doc_1", "doc_2", "doc_3"]
});

// Bulk delete by container tag (delete all for a user)
await client.documents.deleteBulk({
  containerTags: ["user_123"]
});
Deletes are permanent — no recovery.

Processing Queue

Check documents currently being processed.
const response = await client.documents.listProcessing();
console.log(`${response.documents.length} documents processing`);

Next Steps