Skip to main content
GET
/
v0
/
documents
/
tests
/
{id}
Get document test detail
curl --request GET \
  --url https://api.avidoai.com/v0/documents/tests/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "type": "KNOWLEDGE_COVERAGE",
    "status": "COMPLETED",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "meceMeanOverlap": 0.42,
    "meceMeanContradictions": 1.7,
    "results": {
      "results": [
        {
          "task": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>"
          },
          "coverage": 123,
          "reasoning": "<string>",
          "matchedDocuments": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "title": "<string>"
            }
          ]
        }
      ],
      "score": 123,
      "unmappedDocuments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Unique identifier of the document test

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

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

Response

Successfully retrieved document test

Successful response containing document test data

data
DocumentTest · object
required

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