Trigger document test

Creates and triggers a document test execution. For KNOWLEDGE_COVERAGE and DOCS_TO_TASKS_MAPPING, applicationId is required.

POST /v0/documents/tests/trigger

Trigger document test

cURL

curl --request POST \
  --url https://api.avidoai.com/v0/documents/tests/trigger \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "type": "KNOWLEDGE_COVERAGE"
}
'

201

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "type": "KNOWLEDGE_COVERAGE",
    "status": "PENDING",
    "results": null,
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z"
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Body

application/json

Request body for triggering a document test execution

type · enum<string> · required

Type of document test

Available options: KNOWLEDGE_COVERAGE, MECE, DOCS_TO_TASKS_MAPPING

Example:

"KNOWLEDGE_COVERAGE"

Response

201

application/json

Document test triggered successfully

Successful response containing document test data

data · DocumentTest · object · required

A document test execution for evaluating knowledge base quality (MECE, Coverage, etc.)

Show child attributes