Skip to main content
GET
/
exams
/
{EXAM_ID}
Get exam by ID
curl --request GET \
  --url https://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_ID} \
  --header 'x-daai-api-key: <api-key>' \
  --header 'x-daai-professional-id: <x-daai-professional-id>'
import requests

url = "https://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_ID}"

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

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

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

fetch('https://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_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://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_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-daai-api-key: <api-key>",
"x-daai-professional-id: <x-daai-professional-id>"
],
]);

$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://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_ID}"

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

req.Header.Add("x-daai-professional-id", "<x-daai-professional-id>")
req.Header.Add("x-daai-api-key", "<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://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_ID}")
.header("x-daai-professional-id", "<x-daai-professional-id>")
.header("x-daai-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://apim.doctorassistant.ai/api/sandbox/exams/{EXAM_ID}")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "rnq71oedacu1ieqmpc80yu3x",
  "status": "completed",
  "metadata": {
    "patient_id": "123456",
    "exam_type": "blood_test"
  },
  "content": {
    "date": {
      "title": "Exam Date",
      "content": "11/24/2017"
    },
    "tests": {
      "title": "Test Results",
      "content": [
        {
          "test_name": {
            "title": "Test Name",
            "content": "Red Blood Cells"
          },
          "result": {
            "title": "Result",
            "content": "4.24 million/mm3"
          },
          "numeric_result": {
            "title": "Numeric Result",
            "content": "4.24 million/mm3"
          },
          "reference_value": {
            "title": "Reference Value",
            "content": [
              "3.90 to 5.03 million/mm3"
            ]
          },
          "is_normal": {
            "title": "Within reference range",
            "content": true
          }
        }
      ]
    },
    "exam_type": {
      "title": "Exam Type",
      "content": "Clinical Laboratory Test"
    },
    "patient_name": {
      "title": "Patient Name",
      "content": "JOHN DOE"
    }
  }
}
{
"message": "Unauthorized",
"statusCode": 401
}
{
"message": "Exam not found",
"error": "Not Found",
"statusCode": 404
}

Authorizations

x-daai-api-key
string
header
required

API key for authentication

Headers

x-daai-professional-id
string
required

Professional ID responsible for processing the exams

Path Parameters

EXAM_ID
string
required

Unique exam ID

Response

Exam found successfully

id
string
required

Unique exam ID

Example:

"rnq71oedacu1ieqmpc80yu3x"

status
enum<string>
required

Processing status

Available options:
pending,
in-progress,
completed,
failed
Example:

"completed"

metadata
object
required

Exam metadata as sent in the request

Example:
{
"patient_id": "123456",
"exam_type": "blood_test"
}
content
object
required

Processed exam content with flexible structure. The schema varies by exam type and may include:

  • date: Exam date
  • tests: Array with test results
  • exam_type: Type of exam
  • patient_name: Patient name
  • Other fields specific to the exam type