Update Document
curl --request PUT \
--url https://api.simplicity.ai/v1/documents/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"original_filename": "<string>",
"metadata": {
"title": "<string>",
"keywords": [
"<string>"
]
}
}
'import requests
url = "https://api.simplicity.ai/v1/documents/{document_id}"
payload = {
"original_filename": "<string>",
"metadata": {
"title": "<string>",
"keywords": ["<string>"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
original_filename: '<string>',
metadata: {title: '<string>', keywords: ['<string>']}
})
};
fetch('https://api.simplicity.ai/v1/documents/{document_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.simplicity.ai/v1/documents/{document_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([
'original_filename' => '<string>',
'metadata' => [
'title' => '<string>',
'keywords' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.simplicity.ai/v1/documents/{document_id}"
payload := strings.NewReader("{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.simplicity.ai/v1/documents/{document_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simplicity.ai/v1/documents/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"form_id": "<string>",
"form_name": "<string>",
"original_form_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"form_description": "<string>",
"form_title": "<string>",
"form_url": "<string>",
"last_filled_at": "2023-11-07T05:31:56Z",
"file_size": 123,
"fillable_field_count": 123,
"source_document_details": [
{
"file_key": "<string>",
"external_document_id": "<string>",
"document_id": "<string>",
"extension": "<string>",
"original_filename": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Documents
Update Document
Update the details or contents of an existing document.
PUT
/
v1
/
documents
/
{document_id}
Update Document
curl --request PUT \
--url https://api.simplicity.ai/v1/documents/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"original_filename": "<string>",
"metadata": {
"title": "<string>",
"keywords": [
"<string>"
]
}
}
'import requests
url = "https://api.simplicity.ai/v1/documents/{document_id}"
payload = {
"original_filename": "<string>",
"metadata": {
"title": "<string>",
"keywords": ["<string>"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
original_filename: '<string>',
metadata: {title: '<string>', keywords: ['<string>']}
})
};
fetch('https://api.simplicity.ai/v1/documents/{document_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.simplicity.ai/v1/documents/{document_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([
'original_filename' => '<string>',
'metadata' => [
'title' => '<string>',
'keywords' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.simplicity.ai/v1/documents/{document_id}"
payload := strings.NewReader("{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.simplicity.ai/v1/documents/{document_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simplicity.ai/v1/documents/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"original_filename\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"form_id": "<string>",
"form_name": "<string>",
"original_form_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"form_description": "<string>",
"form_title": "<string>",
"form_url": "<string>",
"last_filled_at": "2023-11-07T05:31:56Z",
"file_size": 123,
"fillable_field_count": 123,
"source_document_details": [
{
"file_key": "<string>",
"external_document_id": "<string>",
"document_id": "<string>",
"extension": "<string>",
"original_filename": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
⌘I