Skip to main content
PUT
/
v0
/
documents
/
{id}
Update a document's topic
curl --request PUT \
  --url https://api.avidoai.com/v0/documents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "topicId": "789e1234-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",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "type": "KNOWLEDGE",
    "optimized": false,
    "isVerified": false,
    "status": "ACTIVE",
    "versions": [
      {
        "id": "321e4567-e89b-12d3-a456-426614174001",
        "createdAt": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z",
        "orgId": "org_123456789",
        "applicationId": "456e4567-e89b-12d3-a456-426614174000",
        "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"
      }
    ],
    "title": "<string>",
    "content": "<string>",
    "assignee": "user_123456789",
    "scrapeJob": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123",
      "applicationId": "456e4567-e89b-12d3-a456-426614174000",
      "initiatedBy": "user_123",
      "name": "Documentation Scrape",
      "url": "https://example.com",
      "status": "PENDING",
      "quickstartStatus": "NOT_ASSOCIATED",
      "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"
        }
      ],
      "failedPages": [
        {
          "url": "https://example.com/page3",
          "error": "Connection timeout after 5 retries"
        }
      ]
    },
    "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
    "fileProcessingId": "654e7890-e89b-12d3-a456-426614174000",
    "topicId": "789e1234-e89b-12d3-a456-426614174000"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt

Use this file to discover all available pages before exploring further.

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"

Body

application/json

Request body for updating a document's topic

​
topicId
string<uuid> · null · null
required

The ID of the topic to assign to the document, or null to remove the topic

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:

"789e1234-e89b-12d3-a456-426614174000"

Response

Document topic updated successfully

Successful response containing the document data

​
document
object
required