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>'
import requests

url = "https://api.avidoai.com/v0/documents/tests/{id}"

headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-application-id': '<api-key>'}
};

fetch('https://api.avidoai.com/v0/documents/tests/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/documents/tests/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.avidoai.com/v0/documents/tests/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.avidoai.com/v0/documents/tests/{id}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.avidoai.com/v0/documents/tests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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>"
        }
      ]
    }
  }
}
{
"message": "Resource not found"
}
{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}
{
"message": "Resource not found"
}

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.)