Skip to main content
POST
/
document
/
update
Update Document
curl --request POST \
  --url https://api.stax.ai/document/update \
  --header 'Content-Type: application/json' \
  --cookie authToken= \
  --data '
{
  "docDiff": {
    "name": "<string>",
    "stack": "<string>",
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>",
        "expression": "<string>",
        "class": "<string>",
        "tags": [
          123
        ],
        "pages": [
          123
        ],
        "ref": "<string>",
        "confidence": 123
      }
    ],
    "tables": [
      {
        "raw": true,
        "title": "<string>",
        "lastModified": "2023-11-07T05:31:56Z",
        "createdON": "2023-11-07T05:31:56Z",
        "page": 123,
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123,
        "headers": [
          "<string>"
        ],
        "tags": [
          {
            "row": 123,
            "col": 123,
            "key": "<string>"
          }
        ],
        "rows": [
          {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123,
            "page": 123,
            "cells": [
              {
                "x": 123,
                "y": 123,
                "width": 123,
                "height": 123,
                "text": "<string>",
                "confidence": 123
              }
            ],
            "class": "<string>",
            "classConfidence": 123
          }
        ]
      }
    ],
    "reviewed": true,
    "archived": true,
    "urgent": true,
    "flagged": true,
    "pinned": true,
    "assignee": "<string>",
    "deadline": "2023-11-07T05:31:56Z",
    "sharing": {
      "public": true,
      "protected": {
        "emails": [
          "<string>"
        ],
        "teams": [
          "<string>"
        ],
        "password": "<string>"
      },
      "access": [
        {
          "email": "<string>",
          "usage": 123
        }
      ]
    },
    "notes": [
      {
        "page": 123,
        "thread": [
          {
            "text": "<string>",
            "user": "<string>",
            "timestamp": "2023-11-07T05:31:56Z"
          }
        ],
        "tags": [
          "<string>"
        ],
        "x": 123,
        "y": 123
      }
    ],
    "sync": [
      {
        "user": "<string>",
        "key": "<string>",
        "path": "<string>",
        "override": true,
        "error": "<string>",
        "step": "<string>",
        "job": "<string>",
        "isSynced": true,
        "queuedOn": "2023-11-07T05:31:56Z",
        "syncedOn": "2023-11-07T05:31:56Z"
      }
    ],
    "indexStatement": true
  },
  "docId": "<string>",
  "docIds": [
    "<string>"
  ]
}
'
{
  "success": true
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Body

application/json
docDiff
object
required

Fields to update

docId
string

Single document ID

docIds
string[]

Multiple document IDs for bulk update

MongoDB ObjectId

Response

Document updated successfully

success
boolean
required
Example:

true