PUT
/
v0
/
documents
/
{id}
curl --request PUT \
  --url https://api.avidoai.com/v0/documents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "status": "APPROVED"
}'
{
  "document": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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": {},
    "language": "english",
    "originalSentences": [
      "This is the first sentence.",
      "This is the second sentence."
    ],
    "status": "APPROVED",
    "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_123456789",
      "initiatedBy": "user_123456789",
      "name": "Documentation Scrape",
      "url": "https://docs.example.com",
      "pages": {},
      "status": "COMPLETED"
    },
    "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
    "children": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "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": {},
        "language": "english",
        "originalSentences": [
          "This is the first sentence.",
          "This is the second sentence."
        ],
        "status": "APPROVED",
        "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_123456789",
          "initiatedBy": "user_123456789",
          "name": "Documentation Scrape",
          "url": "https://docs.example.com",
          "pages": {},
          "status": "COMPLETED"
        },
        "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "parent": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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": {},
      "language": "english",
      "originalSentences": [
        "This is the first sentence.",
        "This is the second sentence."
      ],
      "status": "APPROVED",
      "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_123456789",
        "initiatedBy": "user_123456789",
        "name": "Documentation Scrape",
        "url": "https://docs.example.com",
        "pages": {},
        "status": "COMPLETED"
      },
      "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Path Parameters

​
id
string
required

The unique identifier of the document

Example:

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

Body

application/json

Request body for updating an existing document

Response

200
application/json

Document updated successfully

Successful response containing the document data