Chat Streaming

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

import requests

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

payload = {
    "message": "<string>",
    "agent_id": "<string>",
    "conversation_id": "<string>",
    "library_id": "<string>",
    "library_ids": ["<string>"],
    "document_id": "<string>",
    "document_ids": ["<string>"],
    "view_id": "<string>",
    "filters": {},
    "timezone": 0,
    "read_only": 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_id: '<string>',
    library_ids: ['<string>'],
    document_id: '<string>',
    document_ids: ['<string>'],
    view_id: '<string>',
    filters: {},
    timezone: 0,
    read_only: false
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/chat:streamingResponse', 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}/chat:streamingResponse",
  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_id' => '<string>',
    'library_ids' => [
        '<string>'
    ],
    'document_id' => '<string>',
    'document_ids' => [
        '<string>'
    ],
    'view_id' => '<string>',
    'filters' => [
        
    ],
    'timezone' => 0,
    'read_only' => 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/v1/tenants/{tenant}/chat:streamingResponse"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": 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/v1/tenants/{tenant}/chat:streamingResponse")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": false\n}"

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

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

chat

Chat Streaming

Answers a chat message based on information inside AODocs and returns the response in a streaming fashion. There are three kinds of messages differentiated by the prefix: * "header: " JSON ChatResponseMetadata containing metadata about the answer such as the used sources and links. You can find the definition on the bottom of the page. * "data: " contains the response chunks "data: {chunk}\n\n" These chunks should be concatenated to form the full response. * "progress: " contains the steps of the thinking process of the LLM model

POST

assistant

api

tenants

{tenant}

chat:streamingResponse

Chat Streaming

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

import requests

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

payload = {
    "message": "<string>",
    "agent_id": "<string>",
    "conversation_id": "<string>",
    "library_id": "<string>",
    "library_ids": ["<string>"],
    "document_id": "<string>",
    "document_ids": ["<string>"],
    "view_id": "<string>",
    "filters": {},
    "timezone": 0,
    "read_only": 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_id: '<string>',
    library_ids: ['<string>'],
    document_id: '<string>',
    document_ids: ['<string>'],
    view_id: '<string>',
    filters: {},
    timezone: 0,
    read_only: false
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/chat:streamingResponse', 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}/chat:streamingResponse",
  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_id' => '<string>',
    'library_ids' => [
        '<string>'
    ],
    'document_id' => '<string>',
    'document_ids' => [
        '<string>'
    ],
    'view_id' => '<string>',
    'filters' => [
        
    ],
    'timezone' => 0,
    'read_only' => 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/v1/tenants/{tenant}/chat:streamingResponse"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": 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/v1/tenants/{tenant}/chat:streamingResponse")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"library_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_id\": \"<string>\",\n  \"library_ids\": [\n    \"<string>\"\n  ],\n  \"document_id\": \"<string>\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"view_id\": \"<string>\",\n  \"filters\": {},\n  \"timezone\": 0,\n  \"read_only\": false\n}"

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

{
  "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

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_id

string | null

deprecated

Use library_ids field, answer the question in the context of the library

library_ids

string[] | null

Answer the question in the context of these libraries

document_id

string | null

deprecated

DEPRECATED: use document_ids field, answer the question in the context of the document

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

filters

Filters · object

These filters limit which documents are considered as sources during the answer generation.

timezone

integer

default:0

Timezone of the user. If is not provided we use UTC timezone.
We use this information to accurately interpret time-related queries.
Format: offset from UTC, in minutes

read_only

boolean

default:false

Disable tools that can modify documents for this request

Response

Successful Response