Update Document Details
curl --request PUT \
--url https://api.artosai.com/api/v1/document-mrt/{mrt_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sections": [
{
"order_index": 123,
"level": 123,
"section_id": "<string>",
"section_type": "<string>",
"title": "<string>",
"synopsis": "<string>",
"template_instructions": "<string>",
"template_text": "<string>",
"additional_details": {},
"relevant_chunk_ids": [],
"relevant_chunk_names": [],
"rules": []
}
],
"docx_url": "<string>",
"endpoint_analysis": "<string>",
"output_name": "<string>",
"connector_data_id": "",
"rule_type_to_table_like_status": {},
"auto_increment_regeneration": false
}
'import requests
url = "https://api.artosai.com/api/v1/document-mrt/{mrt_id}"
payload = {
"sections": [
{
"order_index": 123,
"level": 123,
"section_id": "<string>",
"section_type": "<string>",
"title": "<string>",
"synopsis": "<string>",
"template_instructions": "<string>",
"template_text": "<string>",
"additional_details": {},
"relevant_chunk_ids": [],
"relevant_chunk_names": [],
"rules": []
}
],
"docx_url": "<string>",
"endpoint_analysis": "<string>",
"output_name": "<string>",
"connector_data_id": "",
"rule_type_to_table_like_status": {},
"auto_increment_regeneration": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sections: [
{
order_index: 123,
level: 123,
section_id: '<string>',
section_type: '<string>',
title: '<string>',
synopsis: '<string>',
template_instructions: '<string>',
template_text: '<string>',
additional_details: {},
relevant_chunk_ids: [],
relevant_chunk_names: [],
rules: []
}
],
docx_url: '<string>',
endpoint_analysis: '<string>',
output_name: '<string>',
connector_data_id: '',
rule_type_to_table_like_status: {},
auto_increment_regeneration: false
})
};
fetch('https://api.artosai.com/api/v1/document-mrt/{mrt_id}', 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.artosai.com/api/v1/document-mrt/{mrt_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'sections' => [
[
'order_index' => 123,
'level' => 123,
'section_id' => '<string>',
'section_type' => '<string>',
'title' => '<string>',
'synopsis' => '<string>',
'template_instructions' => '<string>',
'template_text' => '<string>',
'additional_details' => [
],
'relevant_chunk_ids' => [
],
'relevant_chunk_names' => [
],
'rules' => [
]
]
],
'docx_url' => '<string>',
'endpoint_analysis' => '<string>',
'output_name' => '<string>',
'connector_data_id' => '',
'rule_type_to_table_like_status' => [
],
'auto_increment_regeneration' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.artosai.com/api/v1/document-mrt/{mrt_id}"
payload := strings.NewReader("{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.artosai.com/api/v1/document-mrt/{mrt_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artosai.com/api/v1/document-mrt/{mrt_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}"
response = http.request(request)
puts response.read_body{
"outline": {}
}Document Details
Update Document Details
Full replacement (PUT) of document details including metadata, sections, and rules. All existing sections and rules are deleted and replaced.
PUT
/
api
/
v1
/
document-mrt
/
{mrt_id}
Update Document Details
curl --request PUT \
--url https://api.artosai.com/api/v1/document-mrt/{mrt_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sections": [
{
"order_index": 123,
"level": 123,
"section_id": "<string>",
"section_type": "<string>",
"title": "<string>",
"synopsis": "<string>",
"template_instructions": "<string>",
"template_text": "<string>",
"additional_details": {},
"relevant_chunk_ids": [],
"relevant_chunk_names": [],
"rules": []
}
],
"docx_url": "<string>",
"endpoint_analysis": "<string>",
"output_name": "<string>",
"connector_data_id": "",
"rule_type_to_table_like_status": {},
"auto_increment_regeneration": false
}
'import requests
url = "https://api.artosai.com/api/v1/document-mrt/{mrt_id}"
payload = {
"sections": [
{
"order_index": 123,
"level": 123,
"section_id": "<string>",
"section_type": "<string>",
"title": "<string>",
"synopsis": "<string>",
"template_instructions": "<string>",
"template_text": "<string>",
"additional_details": {},
"relevant_chunk_ids": [],
"relevant_chunk_names": [],
"rules": []
}
],
"docx_url": "<string>",
"endpoint_analysis": "<string>",
"output_name": "<string>",
"connector_data_id": "",
"rule_type_to_table_like_status": {},
"auto_increment_regeneration": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sections: [
{
order_index: 123,
level: 123,
section_id: '<string>',
section_type: '<string>',
title: '<string>',
synopsis: '<string>',
template_instructions: '<string>',
template_text: '<string>',
additional_details: {},
relevant_chunk_ids: [],
relevant_chunk_names: [],
rules: []
}
],
docx_url: '<string>',
endpoint_analysis: '<string>',
output_name: '<string>',
connector_data_id: '',
rule_type_to_table_like_status: {},
auto_increment_regeneration: false
})
};
fetch('https://api.artosai.com/api/v1/document-mrt/{mrt_id}', 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.artosai.com/api/v1/document-mrt/{mrt_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'sections' => [
[
'order_index' => 123,
'level' => 123,
'section_id' => '<string>',
'section_type' => '<string>',
'title' => '<string>',
'synopsis' => '<string>',
'template_instructions' => '<string>',
'template_text' => '<string>',
'additional_details' => [
],
'relevant_chunk_ids' => [
],
'relevant_chunk_names' => [
],
'rules' => [
]
]
],
'docx_url' => '<string>',
'endpoint_analysis' => '<string>',
'output_name' => '<string>',
'connector_data_id' => '',
'rule_type_to_table_like_status' => [
],
'auto_increment_regeneration' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.artosai.com/api/v1/document-mrt/{mrt_id}"
payload := strings.NewReader("{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.artosai.com/api/v1/document-mrt/{mrt_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artosai.com/api/v1/document-mrt/{mrt_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sections\": [\n {\n \"order_index\": 123,\n \"level\": 123,\n \"section_id\": \"<string>\",\n \"section_type\": \"<string>\",\n \"title\": \"<string>\",\n \"synopsis\": \"<string>\",\n \"template_instructions\": \"<string>\",\n \"template_text\": \"<string>\",\n \"additional_details\": {},\n \"relevant_chunk_ids\": [],\n \"relevant_chunk_names\": [],\n \"rules\": []\n }\n ],\n \"docx_url\": \"<string>\",\n \"endpoint_analysis\": \"<string>\",\n \"output_name\": \"<string>\",\n \"connector_data_id\": \"\",\n \"rule_type_to_table_like_status\": {},\n \"auto_increment_regeneration\": false\n}"
response = http.request(request)
puts response.read_body{
"outline": {}
}Authorizations
Okta access-token JWT sent as a Bearer token. The token identifies the user and scopes access to the user's organization.
Path Parameters
UUID of the document details record
Body
application/json
Sections with nested rules
Show child attributes
Show child attributes
S3 object key of DOCX file
Data connector ID
Rule type mappings
Auto-increment regeneration count
Response
Document details updated successfully
Complete outline with sections
⌘I