Chat V2

curl --request POST \
  --url https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "agent_id": "<string>",
  "conversation_id": "<string>",
  "library_ids": [
    "<string>"
  ],
  "document_ids": [
    "<string>"
  ],
  "view_id": "<string>",
  "timezone": 0,
  "read_only": false,
  "include_quotes": false
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat"

payload = {
    "message": "<string>",
    "agent_id": "<string>",
    "conversation_id": "<string>",
    "library_ids": ["<string>"],
    "document_ids": ["<string>"],
    "view_id": "<string>",
    "timezone": 0,
    "read_only": False,
    "include_quotes": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: '<string>',
    agent_id: '<string>',
    conversation_id: '<string>',
    library_ids: ['<string>'],
    document_ids: ['<string>'],
    view_id: '<string>',
    timezone: 0,
    read_only: false,
    include_quotes: false
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat', 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/v2/tenants/{tenant}/chat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => '<string>',
    'agent_id' => '<string>',
    'conversation_id' => '<string>',
    'library_ids' => [
        '<string>'
    ],
    'document_ids' => [
        '<string>'
    ],
    'view_id' => '<string>',
    'timezone' => 0,
    'read_only' => false,
    'include_quotes' => 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://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}")

	req, _ := http.NewRequest("POST", 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.post("https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}"

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

{
  "metadata": {
    "conversation_id": "<string>",
    "message_id": "<string>",
    "response_id": "<string>"
  },
  "items": [
    {
      "text": "<string>",
      "citations": [
        {
          "id": "<string>",
          "library_id": "<string>",
          "document_id": "<string>",
          "document_title": "<string>",
          "document_link": "<string>",
          "bounding_boxes_available": true,
          "quoted_text": "<string>",
          "attachment_id": "<string>",
          "attachment_name": "<string>",
          "attachment_mime_type": "<string>",
          "attachment_link": "<string>",
          "location_info": "<string>",
          "location_type": "<string>",
          "revision_id": "<string>",
          "external_source_url": "<string>",
          "external_source_title": "<string>",
          "quote_narrowed": false
        }
      ],
      "links": [
        {
          "title": "<string>",
          "url": "<string>"
        }
      ]
    }
  ]
}

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

chat-v2

Chat V2

Answers a chat message with structured response preserving paragraph-level citations.

V2 Changes:

Structured response with items array (paragraphs)
Per-paragraph citations and links
Removed deprecated fields (library_id, document_id)

Response Structure: Each response item represents a paragraph with:

text: The paragraph content
citations: Sources cited in this specific paragraph
links: Search result links related to this paragraph

Example Response:

{
    "metadata": {
        "conversation_id": "uuid",
        "message_id": "uuid",
        "response_id": "uuid"
    },
    "items": [
        {
            "text": "Alice is 32 years old.",
            "citations": [{"document_title": "Employee Records", ...}],
            "links": []
        },
        {
            "text": "She works at AODocs.",
            "citations": [{"document_title": "Team Directory", ...}],
            "links": [{"title": "View directory", "url": "..."}]
        }
    ]
}

POST

assistant

api

tenants

{tenant}

chat

Chat V2

curl --request POST \
  --url https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "agent_id": "<string>",
  "conversation_id": "<string>",
  "library_ids": [
    "<string>"
  ],
  "document_ids": [
    "<string>"
  ],
  "view_id": "<string>",
  "timezone": 0,
  "read_only": false,
  "include_quotes": false
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat"

payload = {
    "message": "<string>",
    "agent_id": "<string>",
    "conversation_id": "<string>",
    "library_ids": ["<string>"],
    "document_ids": ["<string>"],
    "view_id": "<string>",
    "timezone": 0,
    "read_only": False,
    "include_quotes": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: '<string>',
    agent_id: '<string>',
    conversation_id: '<string>',
    library_ids: ['<string>'],
    document_ids: ['<string>'],
    view_id: '<string>',
    timezone: 0,
    read_only: false,
    include_quotes: false
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat', 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/v2/tenants/{tenant}/chat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => '<string>',
    'agent_id' => '<string>',
    'conversation_id' => '<string>',
    'library_ids' => [
        '<string>'
    ],
    'document_ids' => [
        '<string>'
    ],
    'view_id' => '<string>',
    'timezone' => 0,
    'read_only' => false,
    'include_quotes' => 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://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}")

	req, _ := http.NewRequest("POST", 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.post("https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v2/tenants/{tenant}/chat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"timezone\": 0,\n  \"read_only\": false,\n  \"include_quotes\": false\n}"

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

{
  "metadata": {
    "conversation_id": "<string>",
    "message_id": "<string>",
    "response_id": "<string>"
  },
  "items": [
    {
      "text": "<string>",
      "citations": [
        {
          "id": "<string>",
          "library_id": "<string>",
          "document_id": "<string>",
          "document_title": "<string>",
          "document_link": "<string>",
          "bounding_boxes_available": true,
          "quoted_text": "<string>",
          "attachment_id": "<string>",
          "attachment_name": "<string>",
          "attachment_mime_type": "<string>",
          "attachment_link": "<string>",
          "location_info": "<string>",
          "location_type": "<string>",
          "revision_id": "<string>",
          "external_source_url": "<string>",
          "external_source_title": "<string>",
          "quote_narrowed": false
        }
      ],
      "links": [
        {
          "title": "<string>",
          "url": "<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

tenant

string | null

required

The domain of the customer

Example:

"example.com"

Body

application/json

Synchronous chat request with option to exclude quoted text.

message

string

required

The message to be sent to the assistant

agent_id

string | null

The id of the agent to scope this chat request

conversation_id

string | null

The conversation ID of the chat message. If not provided, a new conversation will be created.

library_ids

string[] | null

Answer the question in the context of these libraries

document_ids

string[] | null

Answer the question in the context of these documents

view_id

string | null

Answer the question in the context of the view

timezone

integer

default:0

Timezone of the user. If not provided we use UTC timezone. Format: offset from UTC, in minutes (JavaScript getTimezoneOffset)

read_only

boolean

default:false

Disable tools that can modify documents for this request

include_quotes

boolean | null

default:false

Include quoted text in citations. Set to false to reduce response size.

Response

Successful Response

Structured chat response preserving paragraph-level granularity.

Each response item represents a logical unit (typically a paragraph) with its own citations, links, and search metadata. This allows clients to:

Display inline citations per paragraph
Show relevant search links contextually
Understand which searches contributed to each answer part

Example: { "metadata": { "conversation_id": "uuid", "message_id": "uuid", "response_id": "uuid" }, "items": [ { "text": "Alice is 32 years old.", "citations": [{"document_title": "Employee Records", ...}], "links": [] }, { "text": "She works at AODocs as a software engineer.", "citations": [{"document_title": "Team Directory", ...}], "links": [{"title": "View team directory", "url": "..."}] } ] }

metadata

ChatResponseMetadataV2 · object

required

Metadata including conversation, message, and response IDs

Show child attributes

items

ChatResponseItemV2 · object[]

required

Structured response items, typically paragraphs with their sources

Show child attributes