Skip to main content
POST
/
v0
/
documents
curl --request POST \
  --url https://api.avidoai.com/v0/documents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "assignee": "user_123456789",
  "title": "API Documentation",
  "content": "This document describes the API endpoints...",
  "status": "DRAFT",
  "language": "english"
}
'
{
  "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",
    "optimized": false,
    "versions": [
      {
        "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"
      }
    ],
    "title": "<string>",
    "content": "<string>",
    "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_123",
      "initiatedBy": "user_123",
      "name": "Documentation Scrape",
      "url": "https://example.com",
      "status": "PENDING",
      "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"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new document with its initial version

​
assignee
string
required

User ID of the person assigned to this document

Example:

"user_123456789"

​
title
string
required

Title of the initial document version

Example:

"API Documentation"

​
content
string
required

Content of the initial document version

Example:

"This document describes the API endpoints..."

​
scrapeJobId
string<uuid>

Optional ID of the scrape job that generated this document

Example:

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

​
metadata
object

Optional metadata for the initial document version

​
originalSentences
string[]

Array of original sentences from the source

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

Status of the initial document version

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

"DRAFT"

​
language
string
default:english

Language of the initial document version

Example:

"english"

Response

Document created successfully

Successful response containing the document data

​
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