Skip to main content
GET
/
v0
/
documents
/
{id}
Get a single document by ID
curl --request GET \
  --url https://api.avidoai.com/v0/documents/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <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",
    "assignee": "user_123456789",
    "activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
    "scrapeJobId": null,
    "parent": null,
    "children": [],
    "activeVersion": {
      "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...",
      "status": "APPROVED",
      "originalSentences": [
        "This is the first sentence.",
        "This is the second sentence."
      ],
      "language": "english",
      "metadata": null,
      "versionNumber": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "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...",
        "status": "APPROVED",
        "originalSentences": [
          "This is the first sentence.",
          "This is the second sentence."
        ],
        "language": "english",
        "metadata": null,
        "versionNumber": 1,
        "documentId": "123e4567-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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the document

Example:

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

Response

Successfully retrieved document

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