List retrieval documents
curl --request GET \
--url https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents', 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://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "rrdoc_001",
"retrieval_request_id": "rr_abc123",
"category": "records",
"record_types": [
"medical_records"
],
"file_name": "example_general_hospital_records.pdf",
"file_size": 2456789,
"file_type": "application/pdf",
"page_count": 134,
"created_at": "2025-02-05T15:22:10Z",
"metadata": {
"provider_fee_amount": 85
}
}
],
"next": null,
"previous": null
}{
"error": {
"code": "validation_error",
"message": "The patient.date_of_birth field is required"
}
}Retrieval Requests
List retrieval documents
List records, provider invoices, and available request cost summaries in one response. This endpoint does not accept pagination or category filters. An invoice can appear before it is downloadable; retrieval_request.documents_available is sent when its file becomes available.
GET
/
v2
/
retrieval-requests
/
{retrieval_request_id}
/
documents
List retrieval documents
curl --request GET \
--url https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents', 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://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://enterprise.tavrn.ai/v2/retrieval-requests/{retrieval_request_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "rrdoc_001",
"retrieval_request_id": "rr_abc123",
"category": "records",
"record_types": [
"medical_records"
],
"file_name": "example_general_hospital_records.pdf",
"file_size": 2456789,
"file_type": "application/pdf",
"page_count": 134,
"created_at": "2025-02-05T15:22:10Z",
"metadata": {
"provider_fee_amount": 85
}
}
],
"next": null,
"previous": null
}{
"error": {
"code": "validation_error",
"message": "The patient.date_of_birth field is required"
}
}Authorizations
API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...
Path Parameters
Retrieval request ID
Response
Available retrieval documents
Complete current document list in one response. This endpoint does not paginate or filter by category; next and previous are always null.