Skip to main content
GET
/
v0
/
documents
List documents
curl --request GET \
  --url https://api.avidoai.com/v0/documents \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <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",
      "assignee": "user_123456789",
      "activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
      "scrapeJob": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z",
        "orgId": "org_123",
        "initiatedBy": "user_123",
        "name": "Documentation Scrape",
        "url": "https://example.com",
        "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"
          }
        ],
        "status": "PENDING"
      },
      "scrapeJobId": "321e4567-e89b-12d3-a456-426614174000",
      "optimized": false,
      "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...",
          "metadata": {},
          "originalSentences": [
            "This is the first sentence.",
            "This is the second sentence."
          ],
          "language": "english",
          "status": "APPROVED",
          "versionNumber": 1,
          "documentId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "title": "<string>",
      "content": "<string>",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "API Documentation",
          "color": "#3B82F6"
        }
      ]
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

​
skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
limit
integer
default:25

Number of items to include in the result set.

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

25

​
orderBy
string
default:createdAt

Field to order by in the result set.

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
status
enum<string>

Filter by document version status (filters documents by their active version status) Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED.

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

"APPROVED"

​
tagId
string[]

Filter documents by tag ID

Example:

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

​
search
string

Search in document version title and content

Example:

"API documentation"

​
assignee
string

Filter by assignee user ID

Example:

"user_123456789"

​
scrapeJobId
string<uuid>

Filter by scrape job ID

Example:

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

​
startDate
string<date-time>

Filter documents created after this date (inclusive).

Example:

"2024-01-01T00:00:00.000Z"

​
endDate
string<date-time>

Filter documents created before this date (inclusive).

Example:

"2024-12-31T23:59:59.999Z"

Response

Successfully retrieved documents

Paginated response containing documents

​
data
Core Document · object[]
required
​
pagination
object
required

Pagination metadata returned in a paginated response.