POST
/
v0
/
documents
/
{id}
/
versions
curl --request POST \
  --url https://api.avidoai.com/v0/documents/{id}/versions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "title": "API Documentation v2",
  "content": "This updated document includes new endpoints...",
  "status": "DRAFT"
}'
{
  "version": {
    "id": "321e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456789",
    "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",
    "versionNumber": 1,
    "documentId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "document": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456789",
    "assignee": "user_123456789",
    "activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
    "scrapeJob": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123456789",
      "initiatedBy": "user_123456789",
      "name": "Documentation Scrape",
      "url": "https://docs.example.com",
      "pages": [
        "https://docs.example.com/page1",
        "https://docs.example.com/page2"
      ],
      "status": "COMPLETED"
    },
    "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
    "optimized": false
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Path Parameters

​
id
string<uuid>
required

The unique identifier of the document

Example:

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

Body

application/json · any

The body is of type any.

Response

Document version created successfully

Response containing a specific document version