Skip to main content
PUT
/
v0
/
documents
/
{id}
/
versions
/
{versionNumber}
Update a document version
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"
}'
{
  "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",
    "activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
    "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": "APPROVED",
    "documentId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the document

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
versionNumber
integer
required

The version number

Required range: x > 0
Example:

2

Body

application/json

Fields to update in the document version

Request body for updating a specific document version. Only version-specific fields can be updated.

​
title
string

Updated title for the version

Example:

"Updated API Documentation v2"

​
content
string

Updated content for the version

Example:

"This updated document describes the API endpoints..."

​
metadata
object

Updated metadata for the version

​
originalSentences
string[]

Updated array of original sentences from the source

Example:
[
  "This is the updated first sentence.",
  "This is the updated second sentence."
]
​
status
enum<string>

Updated status for the version Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED.

Available options:
DRAFT,
REVIEW,
APPROVED,
ARCHIVED
Example:

"APPROVED"

​
language
string

Language of the initial document version

Example:

"english"

Response

Document version updated successfully

Response containing a specific document version

​
version
object
required

A specific version of a document with its content and metadata

​
document
object
required

A Core Document represents a piece of content that can be organized hierarchically with parent-child relationships and supports versioning