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>"
]
}
'import requests
url = "https://api.stax.ai/document/update"
payload = {
"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>"]
}
headers = {
"cookie": "authToken=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'authToken=', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.stax.ai/document/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stax.ai/document/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_COOKIE => "authToken=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stax.ai/document/update"
payload := strings.NewReader("{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "authToken=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stax.ai/document/update")
.header("cookie", "authToken=")
.header("Content-Type", "application/json")
.body("{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stax.ai/document/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'authToken='
request["Content-Type"] = 'application/json'
request.body = "{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": false,
"error": "<string>",
"authError": true
}Document
Update Document
Update document properties and metadata
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>"
]
}
'import requests
url = "https://api.stax.ai/document/update"
payload = {
"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>"]
}
headers = {
"cookie": "authToken=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'authToken=', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.stax.ai/document/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stax.ai/document/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_COOKIE => "authToken=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stax.ai/document/update"
payload := strings.NewReader("{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "authToken=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stax.ai/document/update")
.header("cookie", "authToken=")
.header("Content-Type", "application/json")
.body("{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stax.ai/document/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'authToken='
request["Content-Type"] = 'application/json'
request.body = "{\n \"docDiff\": {\n \"name\": \"<string>\",\n \"stack\": \"<string>\",\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"expression\": \"<string>\",\n \"class\": \"<string>\",\n \"tags\": [\n 123\n ],\n \"pages\": [\n 123\n ],\n \"ref\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"tables\": [\n {\n \"raw\": true,\n \"title\": \"<string>\",\n \"lastModified\": \"2023-11-07T05:31:56Z\",\n \"createdON\": \"2023-11-07T05:31:56Z\",\n \"page\": 123,\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"headers\": [\n \"<string>\"\n ],\n \"tags\": [\n {\n \"row\": 123,\n \"col\": 123,\n \"key\": \"<string>\"\n }\n ],\n \"rows\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"page\": 123,\n \"cells\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"text\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"class\": \"<string>\",\n \"classConfidence\": 123\n }\n ]\n }\n ],\n \"reviewed\": true,\n \"archived\": true,\n \"urgent\": true,\n \"flagged\": true,\n \"pinned\": true,\n \"assignee\": \"<string>\",\n \"deadline\": \"2023-11-07T05:31:56Z\",\n \"sharing\": {\n \"public\": true,\n \"protected\": {\n \"emails\": [\n \"<string>\"\n ],\n \"teams\": [\n \"<string>\"\n ],\n \"password\": \"<string>\"\n },\n \"access\": [\n {\n \"email\": \"<string>\",\n \"usage\": 123\n }\n ]\n },\n \"notes\": [\n {\n \"page\": 123,\n \"thread\": [\n {\n \"text\": \"<string>\",\n \"user\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"x\": 123,\n \"y\": 123\n }\n ],\n \"sync\": [\n {\n \"user\": \"<string>\",\n \"key\": \"<string>\",\n \"path\": \"<string>\",\n \"override\": true,\n \"error\": \"<string>\",\n \"step\": \"<string>\",\n \"job\": \"<string>\",\n \"isSynced\": true,\n \"queuedOn\": \"2023-11-07T05:31:56Z\",\n \"syncedOn\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"indexStatement\": true\n },\n \"docId\": \"<string>\",\n \"docIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": false,
"error": "<string>",
"authError": true
}Authorizations
cookieAuthbearerAuthmoduleAuth
Cookie-based authentication using userId and authToken cookies
Body
application/json
Response
Document updated successfully
Example:
true
⌘I