Update a document's topic
curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"topicId": "789e1234-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.avidoai.com/v0/documents/{id}"
payload = { "topicId": "789e1234-e89b-12d3-a456-426614174000" }
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({topicId: '789e1234-e89b-12d3-a456-426614174000'})
};
fetch('https://api.avidoai.com/v0/documents/{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://api.avidoai.com/v0/documents/{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([
'topicId' => '789e1234-e89b-12d3-a456-426614174000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);
$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://api.avidoai.com/v0/documents/{id}"
payload := strings.NewReader("{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
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://api.avidoai.com/v0/documents/{id}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"type": "KNOWLEDGE",
"optimized": false,
"isVerified": false,
"status": "ACTIVE",
"versions": [
{
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"title": "API Documentation",
"content": "This document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the first sentence.",
"This is the second sentence."
],
"language": "english",
"status": "APPROVED",
"type": "KNOWLEDGE",
"versionNumber": 1,
"documentId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"title": "<string>",
"content": "<string>",
"assignee": "user_123456789",
"scrapeJob": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"initiatedBy": "user_123",
"name": "Documentation Scrape",
"url": "https://example.com",
"status": "PENDING",
"quickstartStatus": "NOT_ASSOCIATED",
"pages": [
{
"url": "https://example.com/page1",
"title": "Page 1",
"description": "This is the first page of the documentation.",
"category": "Documentation"
},
{
"url": "https://example.com/page2"
}
],
"failedPages": [
{
"url": "https://example.com/page3",
"error": "Connection timeout after 5 retries"
}
]
},
"scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
"fileProcessingId": "654e7890-e89b-12d3-a456-426614174000",
"topicId": "789e1234-e89b-12d3-a456-426614174000"
}
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}{
"message": "Resource not found"
}Documents
Update a document's topic
Updates the topic assignment for a specific document. Set topicId to null to remove the topic.
PUT
/
v0
/
documents
/
{id}
Update a document's topic
curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"topicId": "789e1234-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.avidoai.com/v0/documents/{id}"
payload = { "topicId": "789e1234-e89b-12d3-a456-426614174000" }
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({topicId: '789e1234-e89b-12d3-a456-426614174000'})
};
fetch('https://api.avidoai.com/v0/documents/{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://api.avidoai.com/v0/documents/{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([
'topicId' => '789e1234-e89b-12d3-a456-426614174000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);
$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://api.avidoai.com/v0/documents/{id}"
payload := strings.NewReader("{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
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://api.avidoai.com/v0/documents/{id}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"topicId\": \"789e1234-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"type": "KNOWLEDGE",
"optimized": false,
"isVerified": false,
"status": "ACTIVE",
"versions": [
{
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"title": "API Documentation",
"content": "This document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the first sentence.",
"This is the second sentence."
],
"language": "english",
"status": "APPROVED",
"type": "KNOWLEDGE",
"versionNumber": 1,
"documentId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"title": "<string>",
"content": "<string>",
"assignee": "user_123456789",
"scrapeJob": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123",
"applicationId": "456e4567-e89b-12d3-a456-426614174000",
"initiatedBy": "user_123",
"name": "Documentation Scrape",
"url": "https://example.com",
"status": "PENDING",
"quickstartStatus": "NOT_ASSOCIATED",
"pages": [
{
"url": "https://example.com/page1",
"title": "Page 1",
"description": "This is the first page of the documentation.",
"category": "Documentation"
},
{
"url": "https://example.com/page2"
}
],
"failedPages": [
{
"url": "https://example.com/page3",
"error": "Connection timeout after 5 retries"
}
]
},
"scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
"fileProcessingId": "654e7890-e89b-12d3-a456-426614174000",
"topicId": "789e1234-e89b-12d3-a456-426614174000"
}
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}{
"message": "Resource not found"
}Authorizations
Your unique Avido API key
Your unique Avido Application ID
Path Parameters
The unique identifier of the document
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Example:
"123e4567-e89b-12d3-a456-426614174000"
Body
application/json
Request body for updating a document's topic
The ID of the topic to assign to the document, or null to remove the topic
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Example:
"789e1234-e89b-12d3-a456-426614174000"
Response
Document topic updated successfully
Successful response containing the document data
Show child attributes
Show child attributes
⌘I