GET
/
v0
/
documents
/
{id}
curl --request GET \
  --url https://api.avidoai.com/v0/documents/{id} \
  --header 'x-api-key: <api-key>'
{
  "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...",
    "status": "APPROVED",
    "assignee": "user_123456789",
    "parentId": null,
    "childrenIds": [
      "789e4567-e89b-12d3-a456-426614174000"
    ],
    "originalSentences": [
      "This is the first sentence.",
      "This is the second sentence."
    ],
    "scrapeJobId": null
  }
}

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"

Response

200
application/json

Successfully retrieved document

Successful response containing the document data