Save Tenant - AO Docs Documentation

Save Tenant

curl --request PUT \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "authorized_group": "jsmith@example.com",
  "indexing_daily_quota": 123,
  "chat_daily_quota": 123,
  "document_count_quota": 123,
  "document_count": 123,
  "primary_llm_provider": "OpenAI",
  "google_config": {
    "gcp_project": "<string>",
    "secret_id": "<string>",
    "location": "<string>",
    "default_model": "<string>"
  },
  "openai_config": {
    "secret_id": "<string>",
    "endpoint": "<string>",
    "deployment_name": "<string>",
    "api_version": "<string>",
    "model": "<string>",
    "default_model": "<string>"
  },
  "mistralai_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "anthropic_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "trial": true,
  "trial_available": false,
  "paid_plan": false,
  "trial_end": "2023-11-07T05:31:56Z",
  "library_count": 123,
  "maximum_library_count": 123,
  "capabilities": [],
  "default_library_capabilities": [
    {
      "enabled": true
    }
  ],
  "super_admin_email": "<string>",
  "assistant_name": "<string>",
  "default_agent_id": "<string>",
  "knowledge_base": {
    "library_id": "<string>",
    "document_class_id": "<string>"
  }
}
'

import requests

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

payload = {
    "id": "<string>",
    "authorized_group": "jsmith@example.com",
    "indexing_daily_quota": 123,
    "chat_daily_quota": 123,
    "document_count_quota": 123,
    "document_count": 123,
    "primary_llm_provider": "OpenAI",
    "google_config": {
        "gcp_project": "<string>",
        "secret_id": "<string>",
        "location": "<string>",
        "default_model": "<string>"
    },
    "openai_config": {
        "secret_id": "<string>",
        "endpoint": "<string>",
        "deployment_name": "<string>",
        "api_version": "<string>",
        "model": "<string>",
        "default_model": "<string>"
    },
    "mistralai_config": {
        "secret_id": "<string>",
        "default_model": "<string>"
    },
    "anthropic_config": {
        "secret_id": "<string>",
        "default_model": "<string>"
    },
    "trial": True,
    "trial_available": False,
    "paid_plan": False,
    "trial_end": "2023-11-07T05:31:56Z",
    "library_count": 123,
    "maximum_library_count": 123,
    "capabilities": [],
    "default_library_capabilities": [{ "enabled": True }],
    "super_admin_email": "<string>",
    "assistant_name": "<string>",
    "default_agent_id": "<string>",
    "knowledge_base": {
        "library_id": "<string>",
        "document_class_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({
    id: '<string>',
    authorized_group: 'jsmith@example.com',
    indexing_daily_quota: 123,
    chat_daily_quota: 123,
    document_count_quota: 123,
    document_count: 123,
    primary_llm_provider: 'OpenAI',
    google_config: {
      gcp_project: '<string>',
      secret_id: '<string>',
      location: '<string>',
      default_model: '<string>'
    },
    openai_config: {
      secret_id: '<string>',
      endpoint: '<string>',
      deployment_name: '<string>',
      api_version: '<string>',
      model: '<string>',
      default_model: '<string>'
    },
    mistralai_config: {secret_id: '<string>', default_model: '<string>'},
    anthropic_config: {secret_id: '<string>', default_model: '<string>'},
    trial: true,
    trial_available: false,
    paid_plan: false,
    trial_end: '2023-11-07T05:31:56Z',
    library_count: 123,
    maximum_library_count: 123,
    capabilities: [],
    default_library_capabilities: [{enabled: true}],
    super_admin_email: '<string>',
    assistant_name: '<string>',
    default_agent_id: '<string>',
    knowledge_base: {library_id: '<string>', document_class_id: '<string>'}
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}', 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}",
  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([
    'id' => '<string>',
    'authorized_group' => 'jsmith@example.com',
    'indexing_daily_quota' => 123,
    'chat_daily_quota' => 123,
    'document_count_quota' => 123,
    'document_count' => 123,
    'primary_llm_provider' => 'OpenAI',
    'google_config' => [
        'gcp_project' => '<string>',
        'secret_id' => '<string>',
        'location' => '<string>',
        'default_model' => '<string>'
    ],
    'openai_config' => [
        'secret_id' => '<string>',
        'endpoint' => '<string>',
        'deployment_name' => '<string>',
        'api_version' => '<string>',
        'model' => '<string>',
        'default_model' => '<string>'
    ],
    'mistralai_config' => [
        'secret_id' => '<string>',
        'default_model' => '<string>'
    ],
    'anthropic_config' => [
        'secret_id' => '<string>',
        'default_model' => '<string>'
    ],
    'trial' => true,
    'trial_available' => false,
    'paid_plan' => false,
    'trial_end' => '2023-11-07T05:31:56Z',
    'library_count' => 123,
    'maximum_library_count' => 123,
    'capabilities' => [
        
    ],
    'default_library_capabilities' => [
        [
                'enabled' => true
        ]
    ],
    'super_admin_email' => '<string>',
    'assistant_name' => '<string>',
    'default_agent_id' => '<string>',
    'knowledge_base' => [
        'library_id' => '<string>',
        'document_class_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}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\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}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "authorized_group": "jsmith@example.com",
  "indexing_daily_quota": 123,
  "chat_daily_quota": 123,
  "document_count_quota": 123,
  "document_count": 123,
  "primary_llm_provider": "OpenAI",
  "google_config": {
    "gcp_project": "<string>",
    "secret_id": "<string>",
    "location": "<string>",
    "default_model": "<string>"
  },
  "openai_config": {
    "secret_id": "<string>",
    "endpoint": "<string>",
    "deployment_name": "<string>",
    "api_version": "<string>",
    "model": "<string>",
    "default_model": "<string>"
  },
  "mistralai_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "anthropic_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "trial": true,
  "trial_available": false,
  "paid_plan": false,
  "paid_by": "altirnao",
  "trial_end": "2023-11-07T05:31:56Z",
  "library_count": 123,
  "maximum_library_count": 123,
  "capabilities": [],
  "default_library_capabilities": [
    {
      "capability": "chat",
      "enabled": true
    }
  ],
  "super_admin_email": "<string>",
  "assistant_name": "<string>",
  "default_agent_id": "<string>",
  "knowledge_base": {
    "library_id": "<string>",
    "document_class_id": "<string>"
  }
}

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

PUT

assistant

api

tenants

{tenant}

Save Tenant

curl --request PUT \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "authorized_group": "jsmith@example.com",
  "indexing_daily_quota": 123,
  "chat_daily_quota": 123,
  "document_count_quota": 123,
  "document_count": 123,
  "primary_llm_provider": "OpenAI",
  "google_config": {
    "gcp_project": "<string>",
    "secret_id": "<string>",
    "location": "<string>",
    "default_model": "<string>"
  },
  "openai_config": {
    "secret_id": "<string>",
    "endpoint": "<string>",
    "deployment_name": "<string>",
    "api_version": "<string>",
    "model": "<string>",
    "default_model": "<string>"
  },
  "mistralai_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "anthropic_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "trial": true,
  "trial_available": false,
  "paid_plan": false,
  "trial_end": "2023-11-07T05:31:56Z",
  "library_count": 123,
  "maximum_library_count": 123,
  "capabilities": [],
  "default_library_capabilities": [
    {
      "enabled": true
    }
  ],
  "super_admin_email": "<string>",
  "assistant_name": "<string>",
  "default_agent_id": "<string>",
  "knowledge_base": {
    "library_id": "<string>",
    "document_class_id": "<string>"
  }
}
'

import requests

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

payload = {
    "id": "<string>",
    "authorized_group": "jsmith@example.com",
    "indexing_daily_quota": 123,
    "chat_daily_quota": 123,
    "document_count_quota": 123,
    "document_count": 123,
    "primary_llm_provider": "OpenAI",
    "google_config": {
        "gcp_project": "<string>",
        "secret_id": "<string>",
        "location": "<string>",
        "default_model": "<string>"
    },
    "openai_config": {
        "secret_id": "<string>",
        "endpoint": "<string>",
        "deployment_name": "<string>",
        "api_version": "<string>",
        "model": "<string>",
        "default_model": "<string>"
    },
    "mistralai_config": {
        "secret_id": "<string>",
        "default_model": "<string>"
    },
    "anthropic_config": {
        "secret_id": "<string>",
        "default_model": "<string>"
    },
    "trial": True,
    "trial_available": False,
    "paid_plan": False,
    "trial_end": "2023-11-07T05:31:56Z",
    "library_count": 123,
    "maximum_library_count": 123,
    "capabilities": [],
    "default_library_capabilities": [{ "enabled": True }],
    "super_admin_email": "<string>",
    "assistant_name": "<string>",
    "default_agent_id": "<string>",
    "knowledge_base": {
        "library_id": "<string>",
        "document_class_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({
    id: '<string>',
    authorized_group: 'jsmith@example.com',
    indexing_daily_quota: 123,
    chat_daily_quota: 123,
    document_count_quota: 123,
    document_count: 123,
    primary_llm_provider: 'OpenAI',
    google_config: {
      gcp_project: '<string>',
      secret_id: '<string>',
      location: '<string>',
      default_model: '<string>'
    },
    openai_config: {
      secret_id: '<string>',
      endpoint: '<string>',
      deployment_name: '<string>',
      api_version: '<string>',
      model: '<string>',
      default_model: '<string>'
    },
    mistralai_config: {secret_id: '<string>', default_model: '<string>'},
    anthropic_config: {secret_id: '<string>', default_model: '<string>'},
    trial: true,
    trial_available: false,
    paid_plan: false,
    trial_end: '2023-11-07T05:31:56Z',
    library_count: 123,
    maximum_library_count: 123,
    capabilities: [],
    default_library_capabilities: [{enabled: true}],
    super_admin_email: '<string>',
    assistant_name: '<string>',
    default_agent_id: '<string>',
    knowledge_base: {library_id: '<string>', document_class_id: '<string>'}
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}', 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}",
  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([
    'id' => '<string>',
    'authorized_group' => 'jsmith@example.com',
    'indexing_daily_quota' => 123,
    'chat_daily_quota' => 123,
    'document_count_quota' => 123,
    'document_count' => 123,
    'primary_llm_provider' => 'OpenAI',
    'google_config' => [
        'gcp_project' => '<string>',
        'secret_id' => '<string>',
        'location' => '<string>',
        'default_model' => '<string>'
    ],
    'openai_config' => [
        'secret_id' => '<string>',
        'endpoint' => '<string>',
        'deployment_name' => '<string>',
        'api_version' => '<string>',
        'model' => '<string>',
        'default_model' => '<string>'
    ],
    'mistralai_config' => [
        'secret_id' => '<string>',
        'default_model' => '<string>'
    ],
    'anthropic_config' => [
        'secret_id' => '<string>',
        'default_model' => '<string>'
    ],
    'trial' => true,
    'trial_available' => false,
    'paid_plan' => false,
    'trial_end' => '2023-11-07T05:31:56Z',
    'library_count' => 123,
    'maximum_library_count' => 123,
    'capabilities' => [
        
    ],
    'default_library_capabilities' => [
        [
                'enabled' => true
        ]
    ],
    'super_admin_email' => '<string>',
    'assistant_name' => '<string>',
    'default_agent_id' => '<string>',
    'knowledge_base' => [
        'library_id' => '<string>',
        'document_class_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}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\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}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"<string>\",\n  \"authorized_group\": \"jsmith@example.com\",\n  \"indexing_daily_quota\": 123,\n  \"chat_daily_quota\": 123,\n  \"document_count_quota\": 123,\n  \"document_count\": 123,\n  \"primary_llm_provider\": \"OpenAI\",\n  \"google_config\": {\n    \"gcp_project\": \"<string>\",\n    \"secret_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"openai_config\": {\n    \"secret_id\": \"<string>\",\n    \"endpoint\": \"<string>\",\n    \"deployment_name\": \"<string>\",\n    \"api_version\": \"<string>\",\n    \"model\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"mistralai_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"anthropic_config\": {\n    \"secret_id\": \"<string>\",\n    \"default_model\": \"<string>\"\n  },\n  \"trial\": true,\n  \"trial_available\": false,\n  \"paid_plan\": false,\n  \"trial_end\": \"2023-11-07T05:31:56Z\",\n  \"library_count\": 123,\n  \"maximum_library_count\": 123,\n  \"capabilities\": [],\n  \"default_library_capabilities\": [\n    {\n      \"enabled\": true\n    }\n  ],\n  \"super_admin_email\": \"<string>\",\n  \"assistant_name\": \"<string>\",\n  \"default_agent_id\": \"<string>\",\n  \"knowledge_base\": {\n    \"library_id\": \"<string>\",\n    \"document_class_id\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "authorized_group": "jsmith@example.com",
  "indexing_daily_quota": 123,
  "chat_daily_quota": 123,
  "document_count_quota": 123,
  "document_count": 123,
  "primary_llm_provider": "OpenAI",
  "google_config": {
    "gcp_project": "<string>",
    "secret_id": "<string>",
    "location": "<string>",
    "default_model": "<string>"
  },
  "openai_config": {
    "secret_id": "<string>",
    "endpoint": "<string>",
    "deployment_name": "<string>",
    "api_version": "<string>",
    "model": "<string>",
    "default_model": "<string>"
  },
  "mistralai_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "anthropic_config": {
    "secret_id": "<string>",
    "default_model": "<string>"
  },
  "trial": true,
  "trial_available": false,
  "paid_plan": false,
  "paid_by": "altirnao",
  "trial_end": "2023-11-07T05:31:56Z",
  "library_count": 123,
  "maximum_library_count": 123,
  "capabilities": [],
  "default_library_capabilities": [
    {
      "capability": "chat",
      "enabled": true
    }
  ],
  "super_admin_email": "<string>",
  "assistant_name": "<string>",
  "default_agent_id": "<string>",
  "knowledge_base": {
    "library_id": "<string>",
    "document_class_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

tenant

string

required

The domain of the customer

Example:

"example.com"

Body

application/json

string | null

The id of the tenant. Readonly field.

authorized_group

string<email> | null

If specified only members of this group can access the tenant

indexing_daily_quota

integer | null

The daily spending quota on indexing in dollars

chat_daily_quota

integer | null

The daily spending quota on chat with the assistant in dollars

document_count_quota

integer | null

The maximum number of documents allowed across all configured libraries.

document_count

integer | null

The current number of documents across all configured libraries. Readonly field.

primary_llm_provider

enum<string>

default:OpenAI

The primary LLM provider of the tenant.

Available options:

OpenAI,

Google,

Altirnao,

MistralAI,

Anthropic

google_config

ApiGoogleConfig · object | null

Google provider configuration

Show child attributes

openai_config

ApiOpenAIConfig · object | null

OpenAI configuration

Show child attributes

mistralai_config

ApiMistralAIConfig · object | null

MistralAI configuration

Show child attributes

anthropic_config

ApiAnthropicConfig · object | null

Anthropic configuration

Show child attributes

trial

boolean | null

Indicating trial mode. Readonly field.

trial_available

boolean | null

default:false

Indicating if the trial is available. Readonly field.

paid_plan

boolean | null

default:false

Indicating if the tenant is on a paid plan. Readonly field.

paid_by

enum<string> | null

Who pays for the llm calls

Available options:

altirnao,

customer

trial_end

string<date-time> | null

The end date of the trial. Readonly field.

library_count

integer | null

The number of libraries in the tenant. Readonly field.

maximum_library_count

integer | null

The maximum number of libraries allowed in the tenant. Readonly field.

capabilities

ApiTenantCapability · object[]

List of tenant capabilities. Readonly field.

Show child attributes

default_library_capabilities

ApiLibraryCapability · object[] | null

Default capabilities for newly created libraries. Libraries using defaults will dynamically follow these.

Show child attributes

super_admin_email

string | null

Super admin email used for AODocs API calls that require domain-wide access, such as listing all libraries.

assistant_name

string | null

Name displayed by the UI and used by the assistant to refer to itself.

Maximum string length: 80

default_agent_id

string | null

Default agent ID used when no agent is specified in a chat request.

knowledge_base

ApiKnowledgeBase · object | null

Per-tenant support knowledge base configuration. When set, the support flow answers questions from the configured library in this tenant instead of the shared environment-level knowledge base.

Show child attributes

Response

Successful Response

string | null

The id of the tenant. Readonly field.

authorized_group

string<email> | null

If specified only members of this group can access the tenant

indexing_daily_quota

integer | null

The daily spending quota on indexing in dollars

chat_daily_quota

integer | null

The daily spending quota on chat with the assistant in dollars

document_count_quota

integer | null

The maximum number of documents allowed across all configured libraries.

document_count

integer | null

The current number of documents across all configured libraries. Readonly field.

primary_llm_provider

enum<string>

default:OpenAI

The primary LLM provider of the tenant.

Available options:

OpenAI,

Google,

Altirnao,

MistralAI,

Anthropic

google_config

ApiGoogleConfig · object | null

Google provider configuration

Show child attributes

openai_config

ApiOpenAIConfig · object | null

OpenAI configuration

Show child attributes

mistralai_config

ApiMistralAIConfig · object | null

MistralAI configuration

Show child attributes

anthropic_config

ApiAnthropicConfig · object | null

Anthropic configuration

Show child attributes

trial

boolean | null

Indicating trial mode. Readonly field.

trial_available

boolean | null

default:false

Indicating if the trial is available. Readonly field.

paid_plan

boolean | null

default:false

Indicating if the tenant is on a paid plan. Readonly field.

paid_by

enum<string> | null

Who pays for the llm calls

Available options:

altirnao,

customer

trial_end

string<date-time> | null

The end date of the trial. Readonly field.

library_count

integer | null

The number of libraries in the tenant. Readonly field.

maximum_library_count

integer | null

The maximum number of libraries allowed in the tenant. Readonly field.

capabilities

ApiTenantCapability · object[]

List of tenant capabilities. Readonly field.

Show child attributes

default_library_capabilities

ApiLibraryCapability · object[] | null

Default capabilities for newly created libraries. Libraries using defaults will dynamically follow these.

Show child attributes

super_admin_email

string | null

Super admin email used for AODocs API calls that require domain-wide access, such as listing all libraries.

assistant_name

string | null

Name displayed by the UI and used by the assistant to refer to itself.

Maximum string length: 80

default_agent_id

string | null

Default agent ID used when no agent is specified in a chat request.

knowledge_base

ApiKnowledgeBase · object | null

Per-tenant support knowledge base configuration. When set, the support flow answers questions from the configured library in this tenant instead of the shared environment-level knowledge base.

Show child attributes