Get processing documents

GET/v3/documents/processing

Get documents that are currently being processed

ReturnsExpand Collapse

documents: array of object { id, createdAt, customId, 6 more }

id: string

Unique identifier of the document.

minLength22

maxLength22

createdAt: string

Creation timestamp

formatdatetime

customId: string

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

maxLength255

metadata: string or number or boolean or 2 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:

string

number

boolean

map[unknown]

array of unknown

status: "unknown" or "queued" or "extracting" or 5 more

Status of the document

One of the following:

"unknown"

"queued"

"extracting"

"chunking"

"embedding"

"indexing"

"done"

"failed"

title: string

Title of the document

type: "text" or "pdf" or "tweet" or 10 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"

updatedAt: string

Last update timestamp

formatdatetime

DeprecatedcontainerTags: optional array of string

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.

totalCount: number

Total number of processing documents

Get processing documents

curl https://api.supermemory.ai/v3/documents/processing \
    -H "Authorization: Bearer $SUPERMEMORY_API_KEY"

{
  "documents": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2024-12-27T12:00:00Z",
      "customId": "doc-api-rate-limits",
      "metadata": {
        "source": "bar",
        "language": "bar"
      },
      "status": "extracting",
      "title": "My Document",
      "type": "text",
      "updatedAt": "2024-12-27T12:01:00Z",
      "containerTags": [
        "string"
      ]
    }
  ],
  "totalCount": 5
}

Returns Examples

{
  "documents": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2024-12-27T12:00:00Z",
      "customId": "doc-api-rate-limits",
      "metadata": {
        "source": "bar",
        "language": "bar"
      },
      "status": "extracting",
      "title": "My Document",
      "type": "text",
      "updatedAt": "2024-12-27T12:01:00Z",
      "containerTags": [
        "string"
      ]
    }
  ],
  "totalCount": 5
}