Skip to main content
GET
/
v0
/
documents
/
tests
List document tests
curl --request GET \
  --url https://api.avidoai.com/v0/documents/tests \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "type": "KNOWLEDGE_COVERAGE",
      "status": "COMPLETED",
      "results": {
        "score": 0.85,
        "results": []
      },
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 1,
    "totalPages": 1
  }
}

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"

​
type
enum<string>

Filter by test type

Available options:
KNOWLEDGE_COVERAGE,
MECE,
DOCS_TO_TASKS_MAPPING
Example:

"KNOWLEDGE_COVERAGE"

​
status
enum<string>

Filter by test status

Available options:
PENDING,
IN_PROGRESS,
FAILED,
COMPLETED
Example:

"COMPLETED"

​
start
string<date-time>

Start date (ISO8601) for filtering document tests by creation date

Example:

"2025-01-01T00:00:00Z"

​
end
string<date-time>

End date (ISO8601) for filtering document tests by creation date

Example:

"2025-01-31T23:59:59Z"

Response

Successfully retrieved document tests

Paginated response containing document tests

​
data
DocumentTest · object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.