Patch Agent
curl --request PATCH \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"instructions": "<string>",
"permissions": [
{
"value": "<string>"
}
],
"sources": [
{
"library_id": "<string>",
"classes": [
{
"id": "<string>"
}
],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": [
"<string>"
],
"skill_ids": [
"<string>"
],
"dynamic_filters": [
{
"id": "<string>"
}
],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"name": "<string>"
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}"
payload = {
"description": "<string>",
"instructions": "<string>",
"permissions": [{ "value": "<string>" }],
"sources": [
{
"library_id": "<string>",
"classes": [{ "id": "<string>" }],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": ["<string>"],
"skill_ids": ["<string>"],
"dynamic_filters": [{ "id": "<string>" }],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
instructions: '<string>',
permissions: [{value: '<string>'}],
sources: [
{
library_id: '<string>',
classes: [{id: '<string>'}],
metadata_filters: [{key: '<string>', value: 123, operator: '=='}]
}
],
glossary_ids: ['<string>'],
skill_ids: ['<string>'],
dynamic_filters: [{id: '<string>'}],
dynamic_filter_instructions: '<string>',
llm_profile_id: '<string>',
name: '<string>'
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'instructions' => '<string>',
'permissions' => [
[
'value' => '<string>'
]
],
'sources' => [
[
'library_id' => '<string>',
'classes' => [
[
'id' => '<string>'
]
],
'metadata_filters' => [
[
'key' => '<string>',
'value' => 123,
'operator' => '=='
]
]
]
],
'glossary_ids' => [
'<string>'
],
'skill_ids' => [
'<string>'
],
'dynamic_filters' => [
[
'id' => '<string>'
]
],
'dynamic_filter_instructions' => '<string>',
'llm_profile_id' => '<string>',
'name' => '<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}/agents/{agent_id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"permissions": [
{
"type": "user",
"value": "<string>"
}
],
"sources": [
{
"library_id": "<string>",
"library_name": "<string>",
"classes": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": [
"<string>"
],
"skill_ids": [
"<string>"
],
"dynamic_filters": [
{
"id": "<string>",
"name": "<string>"
}
],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}agent
Patch Agent
Partially update an agent
PATCH
/
assistant
/
api
/
v1
/
tenants
/
{tenant}
/
agents
/
{agent_id}
Patch Agent
curl --request PATCH \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"instructions": "<string>",
"permissions": [
{
"value": "<string>"
}
],
"sources": [
{
"library_id": "<string>",
"classes": [
{
"id": "<string>"
}
],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": [
"<string>"
],
"skill_ids": [
"<string>"
],
"dynamic_filters": [
{
"id": "<string>"
}
],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"name": "<string>"
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}"
payload = {
"description": "<string>",
"instructions": "<string>",
"permissions": [{ "value": "<string>" }],
"sources": [
{
"library_id": "<string>",
"classes": [{ "id": "<string>" }],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": ["<string>"],
"skill_ids": ["<string>"],
"dynamic_filters": [{ "id": "<string>" }],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
instructions: '<string>',
permissions: [{value: '<string>'}],
sources: [
{
library_id: '<string>',
classes: [{id: '<string>'}],
metadata_filters: [{key: '<string>', value: 123, operator: '=='}]
}
],
glossary_ids: ['<string>'],
skill_ids: ['<string>'],
dynamic_filters: [{id: '<string>'}],
dynamic_filter_instructions: '<string>',
llm_profile_id: '<string>',
name: '<string>'
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'instructions' => '<string>',
'permissions' => [
[
'value' => '<string>'
]
],
'sources' => [
[
'library_id' => '<string>',
'classes' => [
[
'id' => '<string>'
]
],
'metadata_filters' => [
[
'key' => '<string>',
'value' => 123,
'operator' => '=='
]
]
]
],
'glossary_ids' => [
'<string>'
],
'skill_ids' => [
'<string>'
],
'dynamic_filters' => [
[
'id' => '<string>'
]
],
'dynamic_filter_instructions' => '<string>',
'llm_profile_id' => '<string>',
'name' => '<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}/agents/{agent_id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"permissions\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"library_id\": \"<string>\",\n \"classes\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"metadata_filters\": [\n {\n \"key\": \"<string>\",\n \"value\": 123,\n \"operator\": \"==\"\n }\n ]\n }\n ],\n \"glossary_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"dynamic_filters\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"dynamic_filter_instructions\": \"<string>\",\n \"llm_profile_id\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"permissions": [
{
"type": "user",
"value": "<string>"
}
],
"sources": [
{
"library_id": "<string>",
"library_name": "<string>",
"classes": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata_filters": [
{
"key": "<string>",
"value": 123,
"operator": "=="
}
]
}
],
"glossary_ids": [
"<string>"
],
"skill_ids": [
"<string>"
],
"dynamic_filters": [
{
"id": "<string>",
"name": "<string>"
}
],
"dynamic_filter_instructions": "<string>",
"llm_profile_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Body
application/json
Partial settings; cross-field constraints are checked after merging.
Response
Successful Response