Get processing documents

GET/v3/documents/processing

Get documents that are currently being processed. Default view=active is the live in-flight queue. view=pending is every unfinished document with no time cutoff. view=all also includes failed documents, paginated.

Query ParametersExpand Collapse

containerTags: optional string

Comma-separated container tags to filter by

limit: optional string or number

Number of items per page. Used with view=all.

One of the following:

string

number

page: optional string or number

Page number to fetch. Used with view=all.

One of the following:

string

number

view: optional "active" or "pending" or "all"

active returns in-flight documents updated in the last 4 hours. pending returns every document that is not done or failed, with no time cutoff. all also includes failed documents, paginated.

One of the following:

"active"

"pending"

"all"

ReturnsExpand Collapse

documents: array of object { id, connectionId, createdAt, 11 more }

id: string

Unique identifier of the document.

minLength22

maxLength22

connectionId: string

Optional ID of connection the document was created from. This is useful for identifying the source 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"

summary: string

Summary of the document content

title: string

Title of the document

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

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.

errorCode: optional string

Stable error code when processing failed, if available

errorMessage: optional string

Human-readable processing error, if available

stuck: optional boolean

True when the document is not done/failed and has not been updated for 4 hours

totalCount: number

Total number of processing documents

pagination: optional object { currentPage, totalItems, totalPages, limit }

Present when view=all

currentPage: number

totalItems: number

totalPages: number

limit: optional number

maximum1100

Get processing documents

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

{
  "documents": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2024-12-27T12:00:00Z",
      "customId": "doc-api-rate-limits",
      "metadata": {
        "source": "bar",
        "language": "bar"
      },
      "status": "extracting",
      "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
      "title": "My Document",
      "type": "text",
      "updatedAt": "2024-12-27T12:01:00Z",
      "containerTags": [
        "string"
      ],
      "errorCode": null,
      "errorMessage": null,
      "stuck": false
    }
  ],
  "totalCount": 5,
  "pagination": {
    "currentPage": 1,
    "totalItems": 100,
    "totalPages": 10,
    "limit": 10
  }
}

Returns Examples

{
  "documents": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxx",
      "connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2024-12-27T12:00:00Z",
      "customId": "doc-api-rate-limits",
      "metadata": {
        "source": "bar",
        "language": "bar"
      },
      "status": "extracting",
      "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
      "title": "My Document",
      "type": "text",
      "updatedAt": "2024-12-27T12:01:00Z",
      "containerTags": [
        "string"
      ],
      "errorCode": null,
      "errorMessage": null,
      "stuck": false
    }
  ],
  "totalCount": 5,
  "pagination": {
    "currentPage": 1,
    "totalItems": 100,
    "totalPages": 10,
    "limit": 10
  }
}