Sign in
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

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' required

Type of the document

updatedAtstring datetime required

Last update timestamp

urlstring nullable
filepathstring nullable required
{"stackTrail":"paths:/v3/documents/{id}:get:responses:200:content:application/json:schema:properties:spatialPoint:anyOf","oasType":"schema","type":"unknown","nullable":true}

Example response

{
  "connectionId": "conn_123",
  "containerTags": [
    "user_123"
  ],
  "content": "This is a detailed article about machine learning concepts...",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "customId": "mem_abc123",
  "id": "acxV5LHMEsG2hMSNb4umbn",
  "metadata": {
    "category": "technology",
    "isPublic": true,
    "readingTime": 5,
    "source": "web",
    "tag_1": "ai",
    "tag_2": "machine-learning"
  },
  "ogImage": "https://example.com/image.jpg",
  "raw": "This is a detailed article about machine learning concepts...",
  "source": "web",
  "status": "done",
  "summary": "A comprehensive guide to understanding the basics of machine learning and its applications.",
  "title": "Introduction to Machine Learning",
  "tokenCount": 1000,
  "type": "text",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "url": "https://example.com/article"
}

Changes

Changed in 9 of the 46 revisions of this API.519

  • f09b91ede9781See the full diff
    • ○

      added the required property filepath to the response with the 200 status

      response-required-property-added

  • 10c98134d2401See the full diff
    • ○

      added the required property taskType to the response with the 200 status

      response-required-property-added

  • cb825424a7802See the full diff
    • ○

      api tag Documents added

      api-tag-added

    • ○

      api tag Manage Documents removed

      api-tag-removed

  • 83aebd1251bc1See the full diff
    • ●

      added the new audio enum value to the type response property for the response status 200

      response-property-enum-value-added

  • 4b4ababc7fb51See the full diff
    • ○

      response property containerTags deprecated

      response-property-deprecated

  • d09553cd7c351See the full diff
    • ○

      added the required property spatialPoint to the response with the 200 status

      response-required-property-added

  • 228aa031e1511See the full diff
    • ○

      api operation id getV3Documents:id removed and replaced with getV3DocumentsById

      api-operation-id-removed

  • 9fef3190aa1b5See the full diff
    • ▲

      removed the required property summaryEmbeddingHv from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property summaryEmbeddingModel from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property summaryEmbeddingModelHv from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property summaryEmbeddingModelNew from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property summaryEmbeddingNew from the response with the 200 status

      response-required-property-removed

  • 1b6cd6c57e232See the full diff
    • ○

      added the required property summaryEmbeddingHv to the response with the 200 status

      response-required-property-added

    • ○

      added the required property summaryEmbeddingModelHv to the response with the 200 status

      response-required-property-added