Save Metadata
curl --request PUT \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": false
}
],
"extraction_instruction": "<string>"
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata"
payload = {
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": False
}
],
"extraction_instruction": "<string>"
}
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({
properties: [
{
id: '<string>',
name: '<string>',
type: '<string>',
description: '<string>',
extraction_instruction: '<string>',
skip_extraction: false
}
],
extraction_instruction: '<string>'
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata",
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([
'properties' => [
[
'id' => '<string>',
'name' => '<string>',
'type' => '<string>',
'description' => '<string>',
'extraction_instruction' => '<string>',
'skip_extraction' => false
]
],
'extraction_instruction' => '<string>'
]),
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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata"
payload := strings.NewReader("{\n \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata")
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 \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": false
}
],
"extraction_instruction": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}metadata
Save Metadata
Save metadata extraction instructions<br>
PUT
/
assistant
/
api
/
v1
/
tenants
/
{tenant}
/
libraries
/
{library_id}
/
classes
/
{class_id}
/
metadata
Save Metadata
curl --request PUT \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": false
}
],
"extraction_instruction": "<string>"
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata"
payload = {
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": False
}
],
"extraction_instruction": "<string>"
}
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({
properties: [
{
id: '<string>',
name: '<string>',
type: '<string>',
description: '<string>',
extraction_instruction: '<string>',
skip_extraction: false
}
],
extraction_instruction: '<string>'
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata",
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([
'properties' => [
[
'id' => '<string>',
'name' => '<string>',
'type' => '<string>',
'description' => '<string>',
'extraction_instruction' => '<string>',
'skip_extraction' => false
]
],
'extraction_instruction' => '<string>'
]),
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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata"
payload := strings.NewReader("{\n \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/classes/{class_id}/metadata")
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 \"properties\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"extraction_instruction\": \"<string>\",\n \"skip_extraction\": false\n }\n ],\n \"extraction_instruction\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"extraction_instruction": "<string>",
"skip_extraction": false
}
],
"extraction_instruction": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the library
The domain of the customer
Example:
"example.com"
Body
application/json