Create a new version of a document

Creates a new version of an existing document. The new version will have the next version number.

POST /v0/documents/{id}/versions

JavaScript

JavaScript

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.create('123e4567-e89b-12d3-a456-426614174000');

console.log(version.document);

201

{
  "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",
    "type": "KNOWLEDGE",
    "versionNumber": 1,
    "documentId": "123e4567-e89b-12d3-a456-426614174000",
    "applicationId": "456e4567-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",
    "type": "KNOWLEDGE",
    "optimized": false,
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "scrapeJob": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123",
      "initiatedBy": "user_123",
      "name": "Documentation Scrape",
      "url": "https://example.com",
      "status": "PENDING",
      "applicationId": "456e4567-e89b-12d3-a456-426614174000",
      "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"
        }
      ]
    },
    "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
    "quickstartId": "456e7890-e89b-12d3-a456-426614174000",
    "topicId": "789e1234-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

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"

Response

201

application/json

Document version created 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

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