Skip to content
supermemory-new
Get started
API Reference
Documents

Get document

documents.get(strid) -> DocumentGetResponse
GET/v3/documents/{id}

Get a document by ID

ParametersExpand Collapse
id: str
ReturnsExpand Collapse
class DocumentGetResponse: …
id: str

Unique identifier of the document.

minLength22
maxLength22
connection_id: Optional[str]

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

minLength22
maxLength22
content: Optional[str]

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.

created_at: str

Creation timestamp

formatdatetime
custom_id: Optional[str]

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

maxLength255
dreaming_status: Literal["dreaming", "done"]
One of the following:
"dreaming"
"done"
filepath: Optional[str]
metadata: Union[str, float, bool, 3 more]

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:
str
float
bool
Dict[str, object]
List[object]
og_image: Optional[str]
raw: object

Raw content of the document

source: Optional[str]

Source of the document

maxLength255
status: Literal["unknown", "queued", "extracting", 5 more]

Status of the document

One of the following:
"unknown"
"queued"
"extracting"
"chunking"
"embedding"
"indexing"
"done"
"failed"
summary: Optional[str]

Summary of the document content

task_type: Literal["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: Optional[str]

Title of the document

type: Literal["text", "pdf", "tweet", 11 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"
"granola"
updated_at: str

Last update timestamp

formatdatetime
Deprecatedcontainer_tags: Optional[List[str]]

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.

memories: Optional[List[Memory]]

Memories extracted from this document. Omitted when the document has no memories (e.g. still processing).

id: str
minLength22
maxLength22
created_at: str

Creation timestamp

formatdatetime
is_forgotten: bool
is_inference: bool
is_latest: bool
is_static: bool
memory: str
metadata: Union[str, float, bool, 3 more]
One of the following:
str
float
bool
Dict[str, object]
List[object]
parent_memory_id: Optional[str]
minLength22
maxLength22
root_memory_id: Optional[str]
minLength22
maxLength22
source_count: int
minimum-2147483648
maximum2147483647
updated_at: Optional[str]

Last update timestamp

formatdatetime
version: int
minimum-2147483648
maximum2147483647
url: Optional[str]

URL of the document

Get document

import os
from supermemory import Supermemory

client = Supermemory(
    api_key=os.environ.get("SUPERMEMORY_API_KEY"),  # This is the default and can be omitted
)
document = client.documents.get(
    "id",
)
print(document.id)
{
  "id": "acxV5LHMEsG2hMSNb4umbn",
  "connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
  "content": "Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "customId": "doc-api-rate-limits",
  "dreamingStatus": "dreaming",
  "filepath": "filepath",
  "metadata": {
    "source": "bar",
    "language": "bar"
  },
  "ogImage": "ogImage",
  "raw": "Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.",
  "source": "text",
  "status": "done",
  "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
  "taskType": "memory",
  "title": "API Rate Limiting Policy",
  "type": "text",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "containerTags": [
    "string"
  ],
  "memories": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "createdAt",
      "isForgotten": true,
      "isInference": true,
      "isLatest": true,
      "isStatic": true,
      "memory": "memory",
      "metadata": "string",
      "parentMemoryId": "xxxxxxxxxxxxxxxxxxxxxx",
      "rootMemoryId": "xxxxxxxxxxxxxxxxxxxxxx",
      "sourceCount": -2147483648,
      "updatedAt": "updatedAt",
      "version": -2147483648
    }
  ],
  "url": "https://docs.example.com/guides/rate-limits"
}
Returns Examples
{
  "id": "acxV5LHMEsG2hMSNb4umbn",
  "connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
  "content": "Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "customId": "doc-api-rate-limits",
  "dreamingStatus": "dreaming",
  "filepath": "filepath",
  "metadata": {
    "source": "bar",
    "language": "bar"
  },
  "ogImage": "ogImage",
  "raw": "Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.",
  "source": "text",
  "status": "done",
  "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
  "taskType": "memory",
  "title": "API Rate Limiting Policy",
  "type": "text",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "containerTags": [
    "string"
  ],
  "memories": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "createdAt",
      "isForgotten": true,
      "isInference": true,
      "isLatest": true,
      "isStatic": true,
      "memory": "memory",
      "metadata": "string",
      "parentMemoryId": "xxxxxxxxxxxxxxxxxxxxxx",
      "rootMemoryId": "xxxxxxxxxxxxxxxxxxxxxx",
      "sourceCount": -2147483648,
      "updatedAt": "updatedAt",
      "version": -2147483648
    }
  ],
  "url": "https://docs.example.com/guides/rate-limits"
}