Create a new document
Creates a new document with the provided information.
Authorizations
Your unique Avido API key
Your unique Avido Application ID
Body
Request body for creating a new document with its initial version
Title of the initial document version
"API Documentation"
Content of the initial document version
"This document describes the API endpoints..."
User ID of the person assigned to this document. Defaults to the authenticated user if not provided.
"user_123456789"
Optional ID of the scrape job that generated this document
^([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)$"321e4567-e89b-12d3-a456-426614174000"
Type of the document. Defaults to KNOWLEDGE.
KNOWLEDGE, POLICY "KNOWLEDGE"
Optional ID of the topic this document belongs to
^([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)$"789e1234-e89b-12d3-a456-426614174000"
Optional metadata for the initial document version
Array of original sentences from the source
[
"This is the first sentence.",
"This is the second sentence."
]Status of the initial document version
DRAFT, REVIEW, APPROVED, ARCHIVED, ACTIVE "DRAFT"
Language of the initial document version
"english"
Response
Document created successfully
Successful response containing the document data