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

PUT

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

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

Show child attributes

metadata.{key}

any

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

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

DocumentVersion · object

required

A specific version of a document with its content and metadata

Show child attributes

version.id

string<uuid>

required

Unique identifier of the document version

Example:

"321e4567-e89b-12d3-a456-426614174001"

version.createdAt

string<date-time>

required

When the document version was created

Example:

"2024-01-05T12:34:56.789Z"

version.modifiedAt

string<date-time>

required

When the document version was last modified

Example:

"2024-01-05T12:34:56.789Z"

version.orgId

string

required

Organization ID that owns this document version

Example:

"org_123456789"

version.title

string

required

Title of the document version

Example:

"API Documentation"

version.content

string

required

Content of the document version

Example:

"This document describes the API endpoints..."

version.metadata

object

required

Optional metadata associated with the document version

Show child attributes

version.metadata.{key}

any

version.originalSentences

string[]

required

Array of original sentences from the source

Example:

[
  "This is the first sentence.",
  "This is the second sentence."
]

version.language

string

required

Language of the document version

Example:

"english"

version.status

enum<string>

required

Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED.

Available options:

DRAFT,

REVIEW,

APPROVED,

ARCHIVED

Example:

"APPROVED"

version.versionNumber

integer

required

Version number of this document version

Example:

1

version.documentId

string<uuid>

required

ID of the document this version belongs to

Example:

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

document

Core Document · object

required

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

Show child attributes

document.id

string<uuid>

required

Unique identifier of the document

Example:

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

document.createdAt

string<date-time>

required

When the document was created

Example:

"2024-01-05T12:34:56.789Z"

document.modifiedAt

string<date-time>

required

When the document was last modified

Example:

"2024-01-05T12:34:56.789Z"

document.orgId

string

required

Organization ID that owns this document

Example:

"org_123456789"

document.assignee

string

required

User ID of the person assigned to this document

Example:

"user_123456789"

document.optimized

boolean

required

Whether the document has been optimized

Example:

false

document.activeVersionId

string<uuid> | null

ID of the currently active version of this document

Example:

"321e4567-e89b-12d3-a456-426614174001"

document.scrapeJob

Scrape Job · object

Optional scrape job that generated this document

Show child attributes

document.scrapeJob.id

string<uuid>

required

The unique identifier of the scrape job

Example:

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

document.scrapeJob.createdAt

string<date-time>

required

When the scrape job was created

Example:

"2024-01-05T12:34:56.789Z"

document.scrapeJob.modifiedAt

string<date-time>

required

When the scrape job was last modified

Example:

"2024-01-05T12:34:56.789Z"

document.scrapeJob.orgId

string

required

Organization ID that owns the scrape job

Example:

"org_123"

document.scrapeJob.initiatedBy

string

required

User ID who initiated the scrape job

Example:

"user_123"

document.scrapeJob.name

string

required

The name/title of the scrape job

Example:

"Documentation Scrape"

document.scrapeJob.url

string<uri>

required

The URL that was scraped

Example:

"https://example.com"

document.scrapeJob.status

enum<string>

required

Current status of the scrape job

Available options:

MAPPING,

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED

Example:

"PENDING"

document.scrapeJob.pages

object[]

The pages scraped from the URL

Show child attributes

document.scrapeJob.pages.url

string<uri>

required

The URL of the page

Example:

"https://example.com/page1"

document.scrapeJob.pages.title

string

The title of the page

Example:

"Page 1"

document.scrapeJob.pages.description

string

The description of the page

Example:

"This is the first page of the documentation."

document.scrapeJob.pages.category

string

The category of the page

Example:

"Documentation"

Example:

[
  {
    "url": "https://example.com/page1",
    "title": "Page 1",
    "description": "This is the first page of the documentation.",
    "category": "Documentation"
  },
  { "url": "https://example.com/page2" }
]

document.scrapeJobId

string<uuid> | null

Optional ID of the scrape job that generated this document

Example:

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

Optimize a document Add tags to multiple documents

⌘I

Webhook

Applications

Threads

Ingestion

Tasks

Task Schedules

Eval Definitions

Experiments

Inference Steps

Evals

Tests

Topics

Annotations

Issues

Runs

Style Guides

Documents

Document Chunks

Document Versions

Tags

Document Tags

Task Tags

Scrape Jobs

Quickstarts

Update a document version

Authorizations

Path Parameters

Body

Response