Sign in

v4

latestOpenAPI 3.1.02026-08-01420618.8 KB
Documents

Get document

Get a document by ID

get/v3/documents/{id}

Path parameters

idstring required

Response

Successfully retrieved document

connectionIdstring nullable required
contentstring nullable required

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.

containerTagsstring[]

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.

createdAtstring datetime required

Creation timestamp

customIdstring nullable required

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

idstring required

Unique identifier of the document.

ogImagestring nullable required
rawstring nullable required

Raw content of the document

sourcestring nullable required

Source of the document

taskType'memory' | 'superrag' required

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

status'unknown' | 'queued' | 'extracting' | 'chunking' | 'embedding' | 'indexing' | 'done' | 'failed' required

Status of the document

dreamingStatus'dreaming' | 'done' required
summarystring nullable required

Summary of the document content

titlestring nullable required

Title of the document

type'text' | 'pdf' | 'tweet' | 'google_doc' | 'google_slide' | 'google_sheet' | 'image' | 'video' | 'audio' | 'notion_doc' | 'webpage' | 'onedrive' | 'github_markdown' | 'granola' required

Type of the document

updatedAtstring datetime required

Last update timestamp

urlstring nullable
filepathstring nullable required

Example response

{
  "id": "acxV5LHMEsG2hMSNb4umbn",
  "content": "Our API rate limits are 100 req/min on free and 1000 on pro.",
  "title": "API Rate Limiting Policy",
  "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
  "status": "done",
  "type": "text",
  "metadata": {
    "source": "upload",
    "language": "en"
  },
  "createdAt": "2025-04-15T09:30:00.000Z",
  "updatedAt": "2025-04-15T09:31:00.000Z"
}