GET
/
v0
/
documents
List documents
curl --request GET \
  --url https://api.avidoai.com/v0/documents \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Query Parameters

​
skip
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
limit
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
Example:

25

​
orderBy
string

Field to order by

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction

Available options:
asc,
desc
Example:

"desc"

​
status
enum<string>

Filter by document status

Available options:
DRAFT,
REVIEW,
APPROVED,
ARCHIVED
Example:

"APPROVED"

​
assignee
string

Filter by assignee user ID

Example:

"user_123456789"

​
parentId
string

Filter by parent document ID

Example:

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

​
scrapeJobId
string

Filter by scrape job ID

Example:

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

Response

200
application/json

Successfully retrieved documents

Paginated response containing documents