import Avido from 'avido';
const client = new Avido({
apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});
const version = await client.documents.versions.update(2, {
id: '123e4567-e89b-12d3-a456-426614174000',
});
console.log(version.document);import os
from avido import Avido
client = Avido(
api_key=os.environ.get("AVIDO_API_KEY"), # This is the default and can be omitted
application_id=os.environ.get("AVIDO_APPLICATION_ID"), # This is the default and can be omitted
)
version = client.documents.versions.update(
version_number=2,
id="123e4567-e89b-12d3-a456-426614174000",
)
print(version.document)curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"title": "Updated API Documentation v2",
"content": "This updated document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the updated first sentence.",
"This is the updated second sentence."
],
"status": "APPROVED",
"language": "english"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber}",
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([
'title' => 'Updated API Documentation v2',
'content' => 'This updated document describes the API endpoints...',
'metadata' => [
],
'originalSentences' => [
'This is the updated first sentence.',
'This is the updated second sentence.'
],
'status' => 'APPROVED',
'language' => 'english'
]),
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}/versions/{versionNumber}"
payload := strings.NewReader("{\n \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\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}/versions/{versionNumber}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber}")
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 \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\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-07T12:34:56.789Z",
"orgId": "org_123456789",
"assignee": "user_123456789",
"scrapeJobId": null
},
"version": {
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-07T12:34:56.789Z",
"orgId": "org_123456789",
"versionNumber": 1,
"title": "Updated API Documentation",
"content": "Updated content...",
"status": "ACTIVE",
"documentId": "123e4567-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"
}Update a document version
Updates the content, title, status, or other fields of a specific document version.
import Avido from 'avido';
const client = new Avido({
apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});
const version = await client.documents.versions.update(2, {
id: '123e4567-e89b-12d3-a456-426614174000',
});
console.log(version.document);import os
from avido import Avido
client = Avido(
api_key=os.environ.get("AVIDO_API_KEY"), # This is the default and can be omitted
application_id=os.environ.get("AVIDO_APPLICATION_ID"), # This is the default and can be omitted
)
version = client.documents.versions.update(
version_number=2,
id="123e4567-e89b-12d3-a456-426614174000",
)
print(version.document)curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"title": "Updated API Documentation v2",
"content": "This updated document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the updated first sentence.",
"This is the updated second sentence."
],
"status": "APPROVED",
"language": "english"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber}",
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([
'title' => 'Updated API Documentation v2',
'content' => 'This updated document describes the API endpoints...',
'metadata' => [
],
'originalSentences' => [
'This is the updated first sentence.',
'This is the updated second sentence.'
],
'status' => 'APPROVED',
'language' => 'english'
]),
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}/versions/{versionNumber}"
payload := strings.NewReader("{\n \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\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}/versions/{versionNumber}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber}")
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 \"title\": \"Updated API Documentation v2\",\n \"content\": \"This updated document describes the API endpoints...\",\n \"metadata\": {},\n \"originalSentences\": [\n \"This is the updated first sentence.\",\n \"This is the updated second sentence.\"\n ],\n \"status\": \"APPROVED\",\n \"language\": \"english\"\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-07T12:34:56.789Z",
"orgId": "org_123456789",
"assignee": "user_123456789",
"scrapeJobId": null
},
"version": {
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-07T12:34:56.789Z",
"orgId": "org_123456789",
"versionNumber": 1,
"title": "Updated API Documentation",
"content": "Updated content...",
"status": "ACTIVE",
"documentId": "123e4567-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
^([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)$"123e4567-e89b-12d3-a456-426614174000"
The version number
x <= 90071992547409912
Body
Fields to update in the document version
Request body for updating a specific document version. Only version-specific fields can be updated.
Updated title for the version
"Updated API Documentation v2"
Updated content for the version
"This updated document describes the API endpoints..."
Updated metadata for the version
Show child attributes
Show child attributes
Updated array of original sentences from the source
[ "This is the updated first sentence.", "This is the updated second sentence." ]
Updated status for the version
DRAFT, REVIEW, APPROVED, ARCHIVED, ACTIVE "APPROVED"
Language of the initial document version
"english"
Response
Document version updated successfully
Response containing a specific document version
A specific version of a document with its content and metadata
Show child attributes
Show child attributes
A Core Document represents a piece of content that can be organized hierarchically with parent-child relationships and supports versioning
Show child attributes
Show child attributes