Get processing documents

Get documents that are currently being processed

GET /v3/documents/processing

Try it

Get processing documents

Javascript

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.supermemory.ai/v3/documents/processing', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "documents": [
    {
      "id": "doc_123",
      "customId": "custom_123",
      "title": "My Document",
      "type": "text",
      "status": "extracting",
      "createdAt": "2024-12-27T12:00:00Z",
      "updatedAt": "2024-12-27T12:01:00Z",
      "metadata": {},
      "containerTags": [
        "sm_project_default"
      ]
    }
  ],
  "totalCount": 5
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Successfully retrieved processing documents

List of documents currently being processed

documents · object[] · required

Show child attributes

documents. id · string · required

Unique identifier of the document.

Required string length: 22

Example:

"acxV5LHMEsG2hMSNb4umbn"

documents. customId · string | null · required

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

Maximum string length: 255

Example:

"mem_abc123"

documents. title · string | null · required

Title of the document

Example:

"Introduction to Machine Learning"

documents. type · enum<string> · required

Type of the document

Available options: text, pdf, tweet, google_doc, google_slide, google_sheet, image, video, notion_doc, webpage, onedrive

Example:

"text"

documents. status · enum<string> · required

Status of the document

Available options: unknown, queued, extracting, chunking, embedding, indexing, done, failed

Example:

"done"

documents. createdAt · string<datetime> · required

Creation timestamp

Example:

"1970-01-01T00:00:00.000Z"

documents. updatedAt · string<datetime> · required

Last update timestamp

Example:

"1970-01-01T00:00:00.000Z"

documents. metadata · required

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.

Example:

{
  "category": "technology",
  "isPublic": true,
  "readingTime": 5,
  "source": "web",
  "tag_1": "ai",
  "tag_2": "machine-learning"
}

documents. containerTags · 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.

Example:

["user_123", "project_123"]

totalCount · number · required

Total number of processing documents

Example:

5