Update Agent - AO Docs Documentation

Update Agent

curl --request PUT \
  --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 '
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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>"
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}"

payload = {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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>"
}
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({
    name: '<string>',
    id: '<string>',
    description: '<string>',
    instructions: '<string>',
    created_at: '2023-11-07T05:31:56Z',
    updated_at: '2023-11-07T05:31:56Z',
    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>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'id' => '<string>',
    'description' => '<string>',
    'instructions' => '<string>',
    'created_at' => '2023-11-07T05:31:56Z',
    'updated_at' => '2023-11-07T05:31:56Z',
    '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>'
  ]),
  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  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}")

	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}/agents/{agent_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}")
  .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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PUT

assistant

api

tenants

{tenant}

agents

{agent_id}

Update Agent

curl --request PUT \
  --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 '
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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>"
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/agents/{agent_id}"

payload = {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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>"
}
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({
    name: '<string>',
    id: '<string>',
    description: '<string>',
    instructions: '<string>',
    created_at: '2023-11-07T05:31:56Z',
    updated_at: '2023-11-07T05:31:56Z',
    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>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'id' => '<string>',
    'description' => '<string>',
    'instructions' => '<string>',
    'created_at' => '2023-11-07T05:31:56Z',
    'updated_at' => '2023-11-07T05:31:56Z',
    '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>'
  ]),
  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  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}")

	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}/agents/{agent_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}")
  .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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\",\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}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id

string

required

tenant

string

required

The domain of the customer

Example:

"example.com"

Body

application/json

name

string

required

The name of the agent

string | null

The id of the agent

description

string | null

The description of the agent

instructions

string | null

Free-text instructions that shape how the agent responds, such as its audience, role, tone, guardrails, and answer format

Maximum string length: 10000

created_at

string<date-time> | null

The date when the agent was created

updated_at

string<date-time> | null

The date when the agent was last updated

permissions

Permission · object[] | null

The permissions of the agent

Show child attributes

sources

DataSource · object[] | null

The sources of the agent

Show child attributes

glossary_ids

string[] | null

The IDs of glossaries associated with the agent

skill_ids

string[] | null

The IDs of skills associated with the agent

dynamic_filters

AgentMetadataFilterField · object[] | null

Low-cardinality metadata fields that the agent may use to scope searches

Show child attributes

dynamic_filter_instructions

string | null

Instructions that help the agent select metadata filter values for a question

Maximum string length: 10000

llm_profile_id

string | null

The ID of the LLM profile that the agent uses, one of the profiles from GET /tenants/{tenant}/llm_profiles. The agent uses the tenant default model when it is null.

Response

Successful Response

name

string

required

The name of the agent

string | null

The id of the agent

description

string | null

The description of the agent

instructions

string | null

Free-text instructions that shape how the agent responds, such as its audience, role, tone, guardrails, and answer format

Maximum string length: 10000

created_at

string<date-time> | null

The date when the agent was created

updated_at

string<date-time> | null

The date when the agent was last updated

permissions

Permission · object[] | null

The permissions of the agent

Show child attributes

sources

DataSource · object[] | null

The sources of the agent

Show child attributes

glossary_ids

string[] | null

The IDs of glossaries associated with the agent

skill_ids

string[] | null

The IDs of skills associated with the agent

dynamic_filters

AgentMetadataFilterField · object[] | null

Low-cardinality metadata fields that the agent may use to scope searches

Show child attributes

dynamic_filter_instructions

string | null

Instructions that help the agent select metadata filter values for a question

Maximum string length: 10000

llm_profile_id

string | null

The ID of the LLM profile that the agent uses, one of the profiles from GET /tenants/{tenant}/llm_profiles. The agent uses the tenant default model when it is null.