{ "error": "Access denied: profile is outside your permission scope"}
{ "error": "Appointment not found"}
{ "error": "Document not found"}
Get a URL that shows the lab results of one profile as a read-only page. Open the URL in a WebView of your app or in a browser tab. Call this endpoint from your server each time the user opens the results, and never cache the URL.Requires the embed and results_view scopes on a profile group of the profile. Aniva grants the embed scope on request. Without one of the two scopes, the request returns 403.
The URL works once and for 5 minutes. When it opens, the page starts a 60-minute session that
only that page holds. Archive your API key to close every open page at once.
Request
Path parameters
string
required
Unique identifier (UUID) of the profile whose results the page shows.
Body
The body is optional. Without a body, the URL opens the biomarker list in the profile’s language.
string
Page language: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr or uk. Default: the language of the profile.
object
The page that the URL opens. Default: { "name": "biomarkers" }. Any other name returns 400.
Show released pages
string
required
One of:
biomarkers: the list of all biomarkers with their latest results.
biomarker: the detail page of one biomarker, with its trend, ranges and explanation. Needs biomarker_id.
twin: the 3D body with a grade per health area. The user selects an area to see its biomarkers.
integer
Only for biomarker. The biomarker_id of the biomarker, as in the results, for example 104. Use the id, not the slug: a slug can change, the id stays.
object
Limits every page to one lab report of the profile. Default: all reports of the profile. Send
exactly one of the three ids. The list, the trend of a biomarker and the twin then show the
results of that report only, and the page hides the appointment filter. The user cannot open
another report with this URL.
Show properties
string
The id of an appointment of the profile. Your key must have access to it, as for
Get Lab Results. If it does not, this endpoint returns
404, not 403.
string
The id of a home kit order of the profile. Your key must have access to it, as for
Get Lab Results for home kit orders, and also needs
home_kit_orders_view or home_kit_orders_manage.
string
The id of a lab report that you uploaded for the profile with
Upload Document. Your key must have access to it, as for
Get Document Results. If it does not, this endpoint
returns 404, not 403. The page shows the date of the lab test, or the upload date when
no value is read yet. While Aniva reads the document and has no value yet, every page tells
the user to open it again in a few minutes.
object
The look of the page. The API adds it to the URL as search params.
Show properties
string
light or dark. Default: the system setting of the device.
string
Hex colour of buttons and links, 3 or 6 digits, with or without #, for example 0f766e.
Default: the brand colour of your profile group, else Aniva orange. Buttons keep white text,
so choose a dark colour.
boolean
Show the logo of your profile group above the results. Default: true.
You can also append the appearance params to a returned URL yourself, before the #token=
fragment: theme=light|dark, primary=<hex> and logo=0. The page ignores an invalid value.
The logo image always comes from your profile group, never from the URL.
Response
On success, the API returns 201 Created.
string
required
The page URL. The launch token is in the #token= fragment, so a browser never sends it to a
server. Open it once.
string
required
ISO 8601 instant after which the URL cannot be opened.
The session is not bound to one page. Inside the embed, the user can move from the twin to a biomarker and between the list and the detail pages. The page shows only lab results: it does not show values that Aniva calculates, files, chat or settings.
Error responses
Status
Description
400
Validation error — invalid profile ID, unknown route.name, invalid biomarker_id, invalid colour, or a report without exactly one valid UUID.
403
Forbidden — your API key is missing the embed or results_view scope, or the home kit scope for a home kit order report, or the profile is outside your access context.
404
Profile not found, or no biomarker has this biomarker_id, or the report is not an appointment, home kit order or uploaded document of this profile, or the report is outside your access. This endpoint returns 404, not 403, so that it does not show that the report exists.
{ "error": "Access denied: profile is outside your permission scope"}
{ "error": "Appointment not found"}
{ "error": "Document not found"}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Aniva API","description":"REST API for lab testing in Germany and the EU: book blood draws at pharmacies and practices, ship home test kits, and get lab results.","colors":{"primary":"#e76c2b","light":"#e76c2b","dark":"#e76c2b"},"logo":{"light":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd","dark":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd"},"favicon":{"light":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.png?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=37c01b349855726e2009a8d5aca4487b","dark":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.png?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=37c01b349855726e2009a8d5aca4487b"},"api":{"openapi":"https://anivahealth.com/api/v1/openapi.json","mdx":{"auth":{"method":"key","name":"x-api-key"}}},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"/status","label":"Status"}]},"footer":{"links":[{"items":[{"label":"Aniva Diagnostics","href":"https://anivahealth.com/diagnostics"},{"label":"hello@anivahealth.com","href":"mailto:hello@anivahealth.com"}]}]},"seo":{"metatags":{"og:locale":"en_US","og:site_name":"Aniva Partner API","keywords":"blood test API, lab testing API, home test kit API, lab results API, biomarker API, pharmacy blood test, Germany, EU"},"indexing":"navigable"},"fonts":{"heading":{"family":"Switzer","weight":600,"source":"https://anivahealth.com/fonts/Switzer-Variable.woff2","format":"woff2"},"body":{"family":"Switzer","source":"https://anivahealth.com/fonts/Switzer-Variable.woff2","format":"woff2"}},"styling":{"latex":false},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"de","navbar":{"links":[{"href":"/de/changelog","label":"Changelog"},{"href":"/de/status","label":"Status"}]},"href":"de"},{"language":"ca","navbar":{"links":[{"href":"/ca/changelog","label":"Registre de canvis"},{"href":"/ca/status","label":"Estat"}]},"href":"ca"},{"language":"cs","navbar":{"links":[{"href":"/cs/changelog","label":"Seznam změn"},{"href":"/cs/status","label":"Stav"}]},"href":"cs"},{"language":"da","navbar":{"links":[{"href":"/da/changelog","label":"Ændringslog"},{"href":"/da/status","label":"Status"}]},"href":"da"},{"language":"es","navbar":{"links":[{"href":"/es/changelog","label":"Registro de cambios"},{"href":"/es/status","label":"Estado"}]},"href":"es"},{"language":"fi","navbar":{"links":[{"href":"/fi/changelog","label":"Muutosloki"},{"href":"/fi/status","label":"Tila"}]},"href":"fi"},{"language":"fr","navbar":{"links":[{"href":"/fr/changelog","label":"Journal des modifications"},{"href":"/fr/status","label":"Statut"}]},"href":"fr"},{"language":"hu","navbar":{"links":[{"href":"/hu/changelog","label":"Változásnapló"},{"href":"/hu/status","label":"Állapot"}]},"href":"hu"},{"language":"it","navbar":{"links":[{"href":"/it/changelog","label":"Changelog"},{"href":"/it/status","label":"Stato"}]},"href":"it"},{"language":"lv","navbar":{"links":[{"href":"/lv/changelog","label":"Izmaiņu žurnāls"},{"href":"/lv/status","label":"Statuss"}]},"href":"lv"},{"language":"nl","navbar":{"links":[{"href":"/nl/changelog","label":"Changelog"},{"href":"/nl/status","label":"Status"}]},"href":"nl"},{"language":"no","navbar":{"links":[{"href":"/no/changelog","label":"Endringslogg"},{"href":"/no/status","label":"Status"}]},"href":"no"},{"language":"pl","navbar":{"links":[{"href":"/pl/changelog","label":"Dziennik zmian"},{"href":"/pl/status","label":"Status"}]},"href":"pl"},{"language":"pt","navbar":{"links":[{"href":"/pt/changelog","label":"Registo de alterações"},{"href":"/pt/status","label":"Estado"}]},"href":"pt"},{"language":"ro","navbar":{"links":[{"href":"/ro/changelog","label":"Jurnal de modificări"},{"href":"/ro/status","label":"Stare"}]},"href":"ro"},{"language":"ru","navbar":{"links":[{"href":"/ru/changelog","label":"История изменений"},{"href":"/ru/status","label":"Статус"}]},"href":"ru"},{"language":"sv","navbar":{"links":[{"href":"/sv/changelog","label":"Ändringslogg"},{"href":"/sv/status","label":"Status"}]},"href":"sv"},{"language":"tr","navbar":{"links":[{"href":"/tr/changelog","label":"Değişiklik günlüğü"},{"href":"/tr/status","label":"Durum"}]},"href":"tr"},{"language":"uk","navbar":{"links":[{"href":"/uk/changelog","label":"Історія змін"},{"href":"/uk/status","label":"Статус"}]},"href":"uk"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"anivahealth","hasAudioNarration":false,"actualSubdomain":"anivahealth","customDomains":["docs.anivahealth.com"],"gitSource":{"type":"github","owner":"anivahealth","repo":"web","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b0344de3ca2a55c0067aa73","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"en","tag":"API Reference","count":61},{"language":"ca","tag":"Referència de l'API","count":61},{"language":"cs","tag":"Reference API","count":61},{"language":"da","tag":"API-reference","count":61},{"language":"de","tag":"API-Referenz","count":61},{"language":"es","tag":"Referencia de la API","count":61},{"language":"fi","tag":"API-viite","count":61},{"language":"fr","tag":"Référence API","count":61},{"language":"hu","tag":"API-referencia","count":61},{"language":"it","tag":"Riferimento API","count":61},{"language":"lv","tag":"API uzziņa","count":61},{"language":"nl","tag":"API-referentie","count":61},{"language":"no","tag":"API-referanse","count":61},{"language":"pl","tag":"Dokumentacja API","count":61},{"language":"pt","tag":"Referência da API","count":61},{"language":"ro","tag":"Referință API","count":61},{"language":"ru","tag":"Справочник API","count":61},{"language":"sv","tag":"API-referens","count":61},{"language":"tr","tag":"API referansı","count":61},{"language":"uk","tag":"Довідник API","count":61},{"language":"en","tag":"Documentation","count":18},{"language":"ca","tag":"Documentació","count":18},{"language":"cs","tag":"Dokumentace","count":18},{"language":"da","tag":"Dokumentation","count":18},{"language":"de","tag":"Dokumentation","count":18},{"language":"es","tag":"Documentación","count":18},{"language":"fi","tag":"Dokumentaatio","count":18},{"language":"fr","tag":"Documentation","count":18},{"language":"hu","tag":"Dokumentáció","count":18},{"language":"it","tag":"Documentazione","count":18},{"language":"lv","tag":"Dokumentācija","count":18},{"language":"nl","tag":"Documentatie","count":18},{"language":"no","tag":"Dokumentasjon","count":18},{"language":"pl","tag":"Dokumentacja","count":18},{"language":"pt","tag":"Documentação","count":18},{"language":"ro","tag":"Documentație","count":18},{"language":"ru","tag":"Документация","count":18},{"language":"sv","tag":"Dokumentation","count":18},{"language":"tr","tag":"Dokümantasyon","count":18},{"language":"uk","tag":"Документація","count":18},{"language":"en","tag":"Appointments","count":13},{"language":"ca","tag":"Cites","count":13},{"language":"cs","tag":"Termíny","count":13},{"language":"da","tag":"Tider","count":13},{"language":"de","tag":"Termine","count":13},{"language":"es","tag":"Citas","count":13},{"language":"fi","tag":"Ajanvaraukset","count":13},{"language":"fr","tag":"Rendez-vous","count":13},{"language":"hu","tag":"Időpontok","count":13},{"language":"it","tag":"Appuntamenti","count":13},{"language":"lv","tag":"Pieraksti","count":13},{"language":"nl","tag":"Afspraken","count":13},{"language":"no","tag":"Timer","count":13},{"language":"pl","tag":"Wizyty","count":13},{"language":"pt","tag":"Marcações","count":13},{"language":"ro","tag":"Programări","count":13},{"language":"ru","tag":"Записи","count":13},{"language":"sv","tag":"Bokningar","count":13},{"language":"tr","tag":"Randevular","count":13},{"language":"uk","tag":"Записи","count":13},{"language":"en","tag":"Home Kit Orders","count":10},{"language":"ca","tag":"Comandes de kits de prova a casa","count":10},{"language":"cs","tag":"Objednávky domácích testovacích sad","count":10},{"language":"da","tag":"Ordrer på hjemmetestkit","count":10},{"language":"de","tag":"Heimtest-Kit-Bestellungen","count":10},{"language":"es","tag":"Pedidos de kits de prueba en casa","count":10},{"language":"fi","tag":"Kotitestipakkausten tilaukset","count":10},{"language":"fr","tag":"Commandes de kits à domicile","count":10},{"language":"hu","tag":"Otthoni tesztkészlet-rendelések","count":10},{"language":"it","tag":"Ordini di kit domiciliari","count":10},{"language":"lv","tag":"Mājas testa komplektu pasūtījumi","count":10},{"language":"nl","tag":"Thuistestkitbestellingen","count":10},{"language":"no","tag":"Bestillinger av hjemmetestsett","count":10},{"language":"pl","tag":"Zamówienia domowych zestawów testowych","count":10},{"language":"pt","tag":"Encomendas de kits de teste em casa","count":10},{"language":"ro","tag":"Comenzi de kituri de testare la domiciliu","count":10},{"language":"ru","tag":"Заказы наборов для домашнего теста","count":10},{"language":"sv","tag":"Beställningar av hemtestkit","count":10},{"language":"tr","tag":"Evde test kiti siparişleri","count":10},{"language":"uk","tag":"Замовлення наборів для домашнього тесту","count":10},{"language":"en","tag":"Webhooks","count":9},{"language":"en","tag":"Core Concepts","count":9},{"language":"ca","tag":"Webhooks","count":9},{"language":"ca","tag":"Conceptes clau","count":9},{"language":"cs","tag":"Webhooky","count":9},{"language":"cs","tag":"Základní koncepty","count":9},{"language":"da","tag":"Webhooks","count":9},{"language":"da","tag":"Kernebegreber","count":9},{"language":"de","tag":"Webhooks","count":9},{"language":"de","tag":"Grundkonzepte","count":9},{"language":"es","tag":"Webhooks","count":9},{"language":"es","tag":"Conceptos clave","count":9},{"language":"fi","tag":"Webhookit","count":9},{"language":"fi","tag":"Peruskäsitteet","count":9},{"language":"fr","tag":"Webhooks","count":9},{"language":"fr","tag":"Concepts clés","count":9},{"language":"hu","tag":"Webhookok","count":9},{"language":"hu","tag":"Alapfogalmak","count":9},{"language":"it","tag":"Webhook","count":9},{"language":"it","tag":"Concetti di base","count":9},{"language":"lv","tag":"Tīmekļa aizķeres","count":9},{"language":"lv","tag":"Pamatjēdzieni","count":9},{"language":"nl","tag":"Webhooks","count":9},{"language":"nl","tag":"Kernconcepten","count":9},{"language":"no","tag":"Webhooks","count":9},{"language":"no","tag":"Kjernekonsepter","count":9},{"language":"pl","tag":"Webhooki","count":9},{"language":"pl","tag":"Podstawowe pojęcia","count":9},{"language":"pt","tag":"Webhooks","count":9},{"language":"pt","tag":"Conceitos principais","count":9},{"language":"ro","tag":"Webhook-uri","count":9},{"language":"ro","tag":"Concepte de bază","count":9},{"language":"ru","tag":"Вебхуки","count":9},{"language":"ru","tag":"Основные понятия","count":9},{"language":"sv","tag":"Webhooks","count":9},{"language":"sv","tag":"Grundkoncept","count":9},{"language":"tr","tag":"Webhook'lar","count":9},{"language":"tr","tag":"Temel kavramlar","count":9},{"language":"uk","tag":"Вебхуки","count":9},{"language":"uk","tag":"Основні поняття","count":9},{"language":"en","tag":"Shipments","count":8},{"language":"ca","tag":"Enviaments","count":8},{"language":"cs","tag":"Zásilky","count":8},{"language":"da","tag":"Forsendelser","count":8},{"language":"de","tag":"Sendungen","count":8},{"language":"es","tag":"Envíos","count":8},{"language":"fi","tag":"Lähetykset","count":8},{"language":"fr","tag":"Expéditions","count":8},{"language":"hu","tag":"Szállítmányok","count":8},{"language":"it","tag":"Spedizioni","count":8},{"language":"lv","tag":"Sūtījumi","count":8},{"language":"nl","tag":"Zendingen","count":8},{"language":"no","tag":"Forsendelser","count":8},{"language":"pl","tag":"Przesyłki","count":8},{"language":"pt","tag":"Envios","count":8},{"language":"ro","tag":"Expedieri","count":8},{"language":"ru","tag":"Отправления","count":8},{"language":"sv","tag":"Försändelser","count":8},{"language":"tr","tag":"Gönderiler","count":8},{"language":"uk","tag":"Відправлення","count":8},{"language":"en","tag":"Get Started","count":6},{"language":"ca","tag":"Primers passos","count":6},{"language":"cs","tag":"Začínáme","count":6},{"language":"da","tag":"Kom i gang","count":6},{"language":"de","tag":"Erste Schritte","count":6},{"language":"es","tag":"Primeros pasos","count":6},{"language":"fi","tag":"Aloitus","count":6},{"language":"fr","tag":"Démarrer","count":6},{"language":"hu","tag":"Első lépések","count":6},{"language":"it","tag":"Per iniziare","count":6},{"language":"lv","tag":"Sākt darbu","count":6},{"language":"nl","tag":"Aan de slag","count":6},{"language":"no","tag":"Kom i gang","count":6},{"language":"pl","tag":"Pierwsze kroki","count":6},{"language":"pt","tag":"Começar","count":6},{"language":"ro","tag":"Primii pași","count":6},{"language":"ru","tag":"Начало работы","count":6},{"language":"sv","tag":"Kom igång","count":6},{"language":"tr","tag":"Başlangıç","count":6},{"language":"uk","tag":"Початок роботи","count":6},{"language":"en","tag":"Locations","count":5},{"language":"en","tag":"Profiles","count":5},{"language":"ca","tag":"Ubicacions","count":5},{"language":"ca","tag":"Perfils","count":5},{"language":"cs","tag":"Lokality","count":5},{"language":"cs","tag":"Profily","count":5},{"language":"da","tag":"Lokationer","count":5},{"language":"da","tag":"Profiler","count":5},{"language":"de","tag":"Standorte","count":5},{"language":"de","tag":"Profile","count":5},{"language":"es","tag":"Ubicaciones","count":5},{"language":"es","tag":"Perfiles","count":5},{"language":"fi","tag":"Toimipisteet","count":5},{"language":"fi","tag":"Profiilit","count":5},{"language":"fr","tag":"Lieux","count":5},{"language":"fr","tag":"Profils","count":5},{"language":"hu","tag":"Helyszínek","count":5},{"language":"hu","tag":"Profilok","count":5},{"language":"it","tag":"Sedi","count":5},{"language":"it","tag":"Profili","count":5},{"language":"lv","tag":"Atrašanās vietas","count":5},{"language":"lv","tag":"Profili","count":5},{"language":"nl","tag":"Locaties","count":5},{"language":"nl","tag":"Profielen","count":5},{"language":"no","tag":"Steder","count":5},{"language":"no","tag":"Profiler","count":5},{"language":"pl","tag":"Lokalizacje","count":5},{"language":"pl","tag":"Profile","count":5},{"language":"pt","tag":"Locais","count":5},{"language":"pt","tag":"Perfis","count":5},{"language":"ro","tag":"Locații","count":5},{"language":"ro","tag":"Profiluri","count":5},{"language":"ru","tag":"Локации","count":5},{"language":"ru","tag":"Профили","count":5},{"language":"sv","tag":"Platser","count":5},{"language":"sv","tag":"Profiler","count":5},{"language":"tr","tag":"Konumlar","count":5},{"language":"tr","tag":"Profiller","count":5},{"language":"uk","tag":"Локації","count":5},{"language":"uk","tag":"Профілі","count":5}],"searchSettings":{"showContentSnippets":true,"maxResults":8}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"update-label\"]{background:transparent;color:rgb(107 114 128);padding-left:0.25rem;padding-right:0;font-weight:400}.dark [data-component-part=\"update-label\"]{color:rgb(156 163 175)}[data-component-part=\"update-tag-list\"]{margin-top:0.25rem;column-gap:0.25rem}[data-component-part=\"update-tag\"]:not(:last-child)::after{content:'·';margin-left:0.25rem}@media (max-width: 1023px){.update-container>div:first-child{flex-direction:row;flex-wrap:wrap;align-items:center;column-gap:0.75rem}.update-container [data-component-part=\"update-tag-list\"]{margin-top:0}}@media (min-width: 640px){[data-component-part=\"update-content\"] img{max-width:85%}}[data-component-part=\"update-content\"] video{cursor:zoom-in}.video-zoom{position:fixed;inset:0;z-index:100;display:flex;align-items:center;justify-content:center;padding:2rem;background:rgb(255 255 255 / 0.9);cursor:zoom-out}.dark .video-zoom{background:rgb(0 0 0 / 0.9)}.video-zoom video{width:100%;max-height:100%;object-fit:contain}.video-zoom-close{position:absolute;top:calc(0.75rem + env(safe-area-inset-top, 0px));right:0.75rem;display:inline-flex;align-items:center;justify-content:center;width:2.25rem;height:2.25rem;border:1px solid rgb(0 0 0 / 0.2);border-radius:9999px;background:rgb(255 255 255 / 0.55);color:rgb(23 23 23);box-shadow:0 0.5px 1px rgb(0 0 0 / 0.12),\n 0 1px 2px rgb(0 0 0 / 0.08),\n inset 0 0.5px 0 rgb(255 255 255 / 0.65);backdrop-filter:blur(40px) saturate(1.5);cursor:pointer}.video-zoom-close:focus{outline:none}.video-zoom-close:focus-visible{outline:2px solid rgb(0 0 0 / 0.25)}.dark .video-zoom-close{border-color:rgb(255 255 255 / 0.25);background:rgb(23 23 23 / 0.45);color:white;box-shadow:0 0 0 0.5px #000,\n 0 0.5px 1px rgb(0 0 0 / 0.45),\n 0 1px 2px rgb(0 0 0 / 0.35),\n inset 0 0.5px 0 rgb(255 255 255 / 0.14)}[data-component-part=\"update-content\"] h2>.absolute{display:none}#content{margin-bottom:2rem}[data-assistant-bar].invisible{display:none}#footer>div{flex-direction:row;flex-wrap:wrap;align-items:center;gap:1rem 2rem;padding-top:5rem;padding-bottom:3rem}#footer>div>div:first-child{flex:1;flex-direction:row;align-items:center;min-height:0}#footer>div>div:first-child>div:last-child{display:flex;justify-content:flex-end}#footer>div>div:first-child>div:last-child>div{align-items:flex-end}#footer>div>div:first-child>div:last-child>div>div{flex-direction:row;gap:1.5rem}#footer>div>div:first-child a{max-width:none}#footer>div>.h-px{display:none}#footer>div>div:last-child{gap:1.5rem}"}]}
{"page":{"pagePath":"api/profiles/create-embed-session","slug":"/api/profiles/create-embed-session","pageMetadata":{"title":"Create Embed Session","description":"Get a one-time URL that shows a profile's lab results inside your app","api":"POST https://anivahealth.com/api/v1/profiles/{id}/embed-sessions","href":"/api/profiles/create-embed-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a one-time URL that shows a profile’s lab results inside your app\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Expandable,Heading,Note,ParamField,ResponseField,Table,Tip}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Get a URL that shows the lab results of one profile as a read-only page. Open the URL in a WebView of your app or in a browser tab. Call this endpoint from your server each time the user opens the results, and never cache the URL.`}),`\n`,_jsxs(_components.p,{children:[`Requires the `,_jsx(_components.code,{children:`embed`}),` and `,_jsx(_components.code,{children:`results_view`}),` scopes on a profile group of the profile. Aniva grants the `,_jsx(_components.code,{children:`embed`}),` scope on request. Without one of the two scopes, the request returns `,_jsx(_components.code,{children:`403`}),`.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The URL works once and for 5 minutes. When it opens, the page starts a 60-minute session that\nonly that page holds. Archive your API key to close every open page at once.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier (UUID) of the profile whose results the page shows.`})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(_components.p,{children:`The body is optional. Without a body, the URL opens the biomarker list in the profile’s language.`}),`\n`,_jsx(ParamField,{body:`language`,type:`string`,id:`param-language`,children:_jsxs(_components.p,{children:[`Page language: `,_jsx(_components.code,{children:`en`}),`, `,_jsx(_components.code,{children:`bg`}),`, `,_jsx(_components.code,{children:`ca`}),`, `,_jsx(_components.code,{children:`cs`}),`, `,_jsx(_components.code,{children:`da`}),`, `,_jsx(_components.code,{children:`de`}),`, `,_jsx(_components.code,{children:`el`}),`, `,_jsx(_components.code,{children:`es`}),`, `,_jsx(_components.code,{children:`et`}),`, `,_jsx(_components.code,{children:`fi`}),`, `,_jsx(_components.code,{children:`fr`}),`, `,_jsx(_components.code,{children:`ga`}),`, `,_jsx(_components.code,{children:`hr`}),`, `,_jsx(_components.code,{children:`hu`}),`, `,_jsx(_components.code,{children:`is`}),`, `,_jsx(_components.code,{children:`it`}),`, `,_jsx(_components.code,{children:`lb`}),`, `,_jsx(_components.code,{children:`lt`}),`, `,_jsx(_components.code,{children:`lv`}),`, `,_jsx(_components.code,{children:`mt`}),`, `,_jsx(_components.code,{children:`nl`}),`, `,_jsx(_components.code,{children:`no`}),`, `,_jsx(_components.code,{children:`pl`}),`, `,_jsx(_components.code,{children:`pt`}),`, `,_jsx(_components.code,{children:`ro`}),`, `,_jsx(_components.code,{children:`ru`}),`, `,_jsx(_components.code,{children:`sk`}),`, `,_jsx(_components.code,{children:`sl`}),`, `,_jsx(_components.code,{children:`sr`}),`, `,_jsx(_components.code,{children:`sv`}),`, `,_jsx(_components.code,{children:`tr`}),` or `,_jsx(_components.code,{children:`uk`}),`. Default: the language of the profile.`]})}),`\n`,_jsxs(ParamField,{body:`route`,type:`object`,id:`param-route`,children:[_jsxs(_components.p,{children:[`The page that the URL opens. Default: `,_jsx(_components.code,{children:`{ \"name\": \"biomarkers\" }`}),`. Any other `,_jsx(_components.code,{children:`name`}),` returns `,_jsx(_components.code,{children:`400`}),`.`]}),_jsxs(Expandable,{title:`released pages`,children:[_jsxs(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:[_jsx(_components.p,{children:`One of:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`biomarkers`}),`: the list of all biomarkers with their latest results.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`biomarker`}),`: the detail page of one biomarker, with its trend, ranges and explanation. Needs `,_jsx(_components.code,{children:`biomarker_id`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`twin`}),`: the 3D body with a grade per health area. The user selects an area to see its biomarkers.`]}),`\n`]})]}),_jsx(ParamField,{body:`biomarker_id`,type:`integer`,id:`param-biomarker-id`,children:_jsxs(_components.p,{children:[`Only for `,_jsx(_components.code,{children:`biomarker`}),`. The `,_jsx(_components.code,{children:`biomarker_id`}),` of the biomarker, as in the results, for example `,_jsx(_components.code,{children:`104`}),`. Use the id, not the slug: a slug can change, the id stays.`]})})]})]}),`\n`,_jsxs(ParamField,{body:`report`,type:`object`,id:`param-report`,children:[_jsx(_components.p,{children:`Limits every page to one lab report of the profile. Default: all reports of the profile. Send\nexactly one of the three ids. The list, the trend of a biomarker and the twin then show the\nresults of that report only, and the page hides the appointment filter. The user cannot open\nanother report with this URL.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`appointment_id`,type:`string`,id:`param-appointment-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of an appointment of the profile. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/appointments/get-results`,children:`Get Lab Results`}),`. If it does not, this endpoint returns\n`,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`.`]})}),_jsx(ParamField,{body:`home_kit_order_id`,type:`string`,id:`param-home-kit-order-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of a home kit order of the profile. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/home-kit-orders/get-results`,children:`Get Lab Results`}),` for home kit orders, and also needs\n`,_jsx(_components.code,{children:`home_kit_orders_view`}),` or `,_jsx(_components.code,{children:`home_kit_orders_manage`}),`.`]})}),_jsx(ParamField,{body:`document_id`,type:`string`,id:`param-document-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of a lab report that you uploaded for the profile with\n`,_jsx(_components.a,{href:`/api/documents/upload-document`,children:`Upload Document`}),`. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/documents/get-document-results`,children:`Get Document Results`}),`. If it does not, this endpoint\nreturns `,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`. The page shows the date of the lab test, or the upload date when\nno value is read yet. While Aniva reads the document and has no value yet, every page tells\nthe user to open it again in a few minutes.`]})})]})]}),`\n`,_jsxs(ParamField,{body:`appearance`,type:`object`,id:`param-appearance`,children:[_jsx(_components.p,{children:`The look of the page. The API adds it to the URL as search params.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`theme`,type:`string`,id:`param-theme`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`light`}),` or `,_jsx(_components.code,{children:`dark`}),`. Default: the system setting of the device.`]})}),_jsx(ParamField,{body:`primary_color`,type:`string`,id:`param-primary-color`,children:_jsxs(_components.p,{children:[`Hex colour of buttons and links, 3 or 6 digits, with or without `,_jsx(_components.code,{children:`#`}),`, for example `,_jsx(_components.code,{children:`0f766e`}),`.\nDefault: the brand colour of your profile group, else Aniva orange. Buttons keep white text,\nso choose a dark colour.`]})}),_jsx(ParamField,{body:`show_logo`,type:`boolean`,id:`param-show-logo`,children:_jsxs(_components.p,{children:[`Show the logo of your profile group above the results. Default: `,_jsx(_components.code,{children:`true`}),`.`]})})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`You can also append the appearance params to a returned URL yourself, before the `,_jsx(_components.code,{children:`#token=`}),`\nfragment: `,_jsx(_components.code,{children:`theme=light|dark`}),`, `,_jsx(_components.code,{children:`primary=\u003chex>`}),` and `,_jsx(_components.code,{children:`logo=0`}),`. The page ignores an invalid value.\nThe logo image always comes from your profile group, never from the URL.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`On success, the API returns `,_jsx(_components.code,{children:`201 Created`}),`.`]}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,required:true,id:`param-url`,children:_jsxs(_components.p,{children:[`The page URL. The launch token is in the `,_jsx(_components.code,{children:`#token=`}),` fragment, so a browser never sends it to a\nserver. Open it once.`]})}),`\n`,_jsx(ResponseField,{name:`expires_at`,type:`string`,required:true,id:`param-expires-at`,children:_jsx(_components.p,{children:`ISO 8601 instant after which the URL cannot be opened.`})}),`\n`,_jsx(_components.p,{children:`The session is not bound to one page. Inside the embed, the user can move from the twin to a biomarker and between the list and the detail pages. The page shows only lab results: it does not show values that Aniva calculates, files, chat or settings.`}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Validation error — invalid profile ID, unknown `,_jsx(_components.code,{children:`route.name`}),`, invalid `,_jsx(_components.code,{children:`biomarker_id`}),`, invalid colour, or a `,_jsx(_components.code,{children:`report`}),` without exactly one valid UUID.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`Forbidden — your API key is missing the `,_jsx(_components.code,{children:`embed`}),` or `,_jsx(_components.code,{children:`results_view`}),` scope, or the home kit scope for a home kit order report, or the profile is outside your access context.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsxs(_components.td,{children:[`Profile not found, or no biomarker has this `,_jsx(_components.code,{children:`biomarker_id`}),`, or the `,_jsx(_components.code,{children:`report`}),` is not an appointment, home kit order or uploaded document of this profile, or the report is outside your access. This endpoint returns `,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`, so that it does not show that the report exists.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Embed Session","description":"Get a one-time URL that shows a profile's lab results inside your app","api":"POST https://anivahealth.com/api/v1/profiles/{id}/embed-sessions","href":"/api/profiles/create-embed-session"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Get a URL that shows the lab results of one profile as a read-only page. Open the URL in a WebView of your app or in a browser tab. Call this endpoint from your server each time the user opens the results, and never cache the URL.`}),`\n`,_jsxs(_components.p,{children:[`Requires the `,_jsx(_components.code,{children:`embed`}),` and `,_jsx(_components.code,{children:`results_view`}),` scopes on a profile group of the profile. Aniva grants the `,_jsx(_components.code,{children:`embed`}),` scope on request. Without one of the two scopes, the request returns `,_jsx(_components.code,{children:`403`}),`.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The URL works once and for 5 minutes. When it opens, the page starts a 60-minute session that\nonly that page holds. Archive your API key to close every open page at once.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier (UUID) of the profile whose results the page shows.`})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(_components.p,{children:`The body is optional. Without a body, the URL opens the biomarker list in the profile’s language.`}),`\n`,_jsx(ParamField,{body:`language`,type:`string`,id:`param-language`,children:_jsxs(_components.p,{children:[`Page language: `,_jsx(_components.code,{children:`en`}),`, `,_jsx(_components.code,{children:`bg`}),`, `,_jsx(_components.code,{children:`ca`}),`, `,_jsx(_components.code,{children:`cs`}),`, `,_jsx(_components.code,{children:`da`}),`, `,_jsx(_components.code,{children:`de`}),`, `,_jsx(_components.code,{children:`el`}),`, `,_jsx(_components.code,{children:`es`}),`, `,_jsx(_components.code,{children:`et`}),`, `,_jsx(_components.code,{children:`fi`}),`, `,_jsx(_components.code,{children:`fr`}),`, `,_jsx(_components.code,{children:`ga`}),`, `,_jsx(_components.code,{children:`hr`}),`, `,_jsx(_components.code,{children:`hu`}),`, `,_jsx(_components.code,{children:`is`}),`, `,_jsx(_components.code,{children:`it`}),`, `,_jsx(_components.code,{children:`lb`}),`, `,_jsx(_components.code,{children:`lt`}),`, `,_jsx(_components.code,{children:`lv`}),`, `,_jsx(_components.code,{children:`mt`}),`, `,_jsx(_components.code,{children:`nl`}),`, `,_jsx(_components.code,{children:`no`}),`, `,_jsx(_components.code,{children:`pl`}),`, `,_jsx(_components.code,{children:`pt`}),`, `,_jsx(_components.code,{children:`ro`}),`, `,_jsx(_components.code,{children:`ru`}),`, `,_jsx(_components.code,{children:`sk`}),`, `,_jsx(_components.code,{children:`sl`}),`, `,_jsx(_components.code,{children:`sr`}),`, `,_jsx(_components.code,{children:`sv`}),`, `,_jsx(_components.code,{children:`tr`}),` or `,_jsx(_components.code,{children:`uk`}),`. Default: the language of the profile.`]})}),`\n`,_jsxs(ParamField,{body:`route`,type:`object`,id:`param-route`,children:[_jsxs(_components.p,{children:[`The page that the URL opens. Default: `,_jsx(_components.code,{children:`{ \"name\": \"biomarkers\" }`}),`. Any other `,_jsx(_components.code,{children:`name`}),` returns `,_jsx(_components.code,{children:`400`}),`.`]}),_jsxs(Expandable,{title:`released pages`,children:[_jsxs(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:[_jsx(_components.p,{children:`One of:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`biomarkers`}),`: the list of all biomarkers with their latest results.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`biomarker`}),`: the detail page of one biomarker, with its trend, ranges and explanation. Needs `,_jsx(_components.code,{children:`biomarker_id`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`twin`}),`: the 3D body with a grade per health area. The user selects an area to see its biomarkers.`]}),`\n`]})]}),_jsx(ParamField,{body:`biomarker_id`,type:`integer`,id:`param-biomarker-id`,children:_jsxs(_components.p,{children:[`Only for `,_jsx(_components.code,{children:`biomarker`}),`. The `,_jsx(_components.code,{children:`biomarker_id`}),` of the biomarker, as in the results, for example `,_jsx(_components.code,{children:`104`}),`. Use the id, not the slug: a slug can change, the id stays.`]})})]})]}),`\n`,_jsxs(ParamField,{body:`report`,type:`object`,id:`param-report`,children:[_jsx(_components.p,{children:`Limits every page to one lab report of the profile. Default: all reports of the profile. Send\nexactly one of the three ids. The list, the trend of a biomarker and the twin then show the\nresults of that report only, and the page hides the appointment filter. The user cannot open\nanother report with this URL.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`appointment_id`,type:`string`,id:`param-appointment-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of an appointment of the profile. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/appointments/get-results`,children:`Get Lab Results`}),`. If it does not, this endpoint returns\n`,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`.`]})}),_jsx(ParamField,{body:`home_kit_order_id`,type:`string`,id:`param-home-kit-order-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of a home kit order of the profile. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/home-kit-orders/get-results`,children:`Get Lab Results`}),` for home kit orders, and also needs\n`,_jsx(_components.code,{children:`home_kit_orders_view`}),` or `,_jsx(_components.code,{children:`home_kit_orders_manage`}),`.`]})}),_jsx(ParamField,{body:`document_id`,type:`string`,id:`param-document-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` of a lab report that you uploaded for the profile with\n`,_jsx(_components.a,{href:`/api/documents/upload-document`,children:`Upload Document`}),`. Your key must have access to it, as for\n`,_jsx(_components.a,{href:`/api/documents/get-document-results`,children:`Get Document Results`}),`. If it does not, this endpoint\nreturns `,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`. The page shows the date of the lab test, or the upload date when\nno value is read yet. While Aniva reads the document and has no value yet, every page tells\nthe user to open it again in a few minutes.`]})})]})]}),`\n`,_jsxs(ParamField,{body:`appearance`,type:`object`,id:`param-appearance`,children:[_jsx(_components.p,{children:`The look of the page. The API adds it to the URL as search params.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`theme`,type:`string`,id:`param-theme`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`light`}),` or `,_jsx(_components.code,{children:`dark`}),`. Default: the system setting of the device.`]})}),_jsx(ParamField,{body:`primary_color`,type:`string`,id:`param-primary-color`,children:_jsxs(_components.p,{children:[`Hex colour of buttons and links, 3 or 6 digits, with or without `,_jsx(_components.code,{children:`#`}),`, for example `,_jsx(_components.code,{children:`0f766e`}),`.\nDefault: the brand colour of your profile group, else Aniva orange. Buttons keep white text,\nso choose a dark colour.`]})}),_jsx(ParamField,{body:`show_logo`,type:`boolean`,id:`param-show-logo`,children:_jsxs(_components.p,{children:[`Show the logo of your profile group above the results. Default: `,_jsx(_components.code,{children:`true`}),`.`]})})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`You can also append the appearance params to a returned URL yourself, before the `,_jsx(_components.code,{children:`#token=`}),`\nfragment: `,_jsx(_components.code,{children:`theme=light|dark`}),`, `,_jsx(_components.code,{children:`primary=\u003chex>`}),` and `,_jsx(_components.code,{children:`logo=0`}),`. The page ignores an invalid value.\nThe logo image always comes from your profile group, never from the URL.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`On success, the API returns `,_jsx(_components.code,{children:`201 Created`}),`.`]}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,required:true,id:`param-url`,children:_jsxs(_components.p,{children:[`The page URL. The launch token is in the `,_jsx(_components.code,{children:`#token=`}),` fragment, so a browser never sends it to a\nserver. Open it once.`]})}),`\n`,_jsx(ResponseField,{name:`expires_at`,type:`string`,required:true,id:`param-expires-at`,children:_jsx(_components.p,{children:`ISO 8601 instant after which the URL cannot be opened.`})}),`\n`,_jsx(_components.p,{children:`The session is not bound to one page. Inside the embed, the user can move from the twin to a biomarker and between the list and the detail pages. The page shows only lab results: it does not show values that Aniva calculates, files, chat or settings.`}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Validation error — invalid profile ID, unknown `,_jsx(_components.code,{children:`route.name`}),`, invalid `,_jsx(_components.code,{children:`biomarker_id`}),`, invalid colour, or a `,_jsx(_components.code,{children:`report`}),` without exactly one valid UUID.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`Forbidden — your API key is missing the `,_jsx(_components.code,{children:`embed`}),` or `,_jsx(_components.code,{children:`results_view`}),` scope, or the home kit scope for a home kit order report, or the profile is outside your access context.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsxs(_components.td,{children:[`Profile not found, or no biomarker has this `,_jsx(_components.code,{children:`biomarker_id`}),`, or the `,_jsx(_components.code,{children:`report`}),` is not an appointment, home kit order or uploaded document of this profile, or the report is outside your access. This endpoint returns `,_jsx(_components.code,{children:`404`}),`, not `,_jsx(_components.code,{children:`403`}),`, so that it does not show that the report exists.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error.`})]})]})]}),`\n`,_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`10`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d/embed-sessions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'x-api-key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"language\": \"de\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"route\": { \"name\": \"biomarker\", \"biomarker_id\": 104 },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"report\": { \"appointment_id\": \"8d2e4f6a-1b3c-4d5e-9f70-a1b2c3d4e5f6\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appearance\": { \"theme\": \"light\", \"primary_color\": \"0f766e\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`One uploaded document`,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://anivahealth.com/api/v1/profiles/{id}/embed-sessions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer \u003capi_key>'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"report\": { \"document_id\": \"3f9a7c2e-5d4b-4e1a-8c6f-0b1d2e3f4a5b\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`201`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://anivahealth.com/de/embed/biomarkers/vitamin-d?theme=light\u0026primary=0f766e#token=eyJwdXJwb3NlIjoiZW1iZWRfbGF1bmNoIi4uLn0.k7Qm2V0sZ1yH\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-19T20:17:43.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"route.name: Invalid discriminator value. Expected 'biomarkers' | 'biomarker' | 'twin'\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`403`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Access denied: profile is outside your permission scope\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`404`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Appointment not found\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`404 document`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Document not found\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Embed Session","description":"Get a one-time URL that shows a profile's lab results inside your app","api":"POST https://anivahealth.com/api/v1/profiles/{id}/embed-sessions","href":"/api/profiles/create-embed-session"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[{"title":"Path parameters","slug":"path-parameters","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Error responses","slug":"error-responses","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"10\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d/embed-sessions\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'x-api-key: YOUR_API_KEY'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"language\": \"de\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"route\": { \"name\": \"biomarker\", \"biomarker_id\": 104 },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"report\": { \"appointment_id\": \"8d2e4f6a-1b3c-4d5e-9f70-a1b2c3d4e5f6\" },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appearance\": { \"theme\": \"light\", \"primary_color\": \"0f766e\" }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"One uploaded document","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"7\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://anivahealth.com/api/v1/profiles/{id}/embed-sessions\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Authorization: Bearer \u0026#x3C;api_key>'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"report\": { \"document_id\": \"3f9a7c2e-5d4b-4e1a-8c6f-0b1d2e3f4a5b\" }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"201","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://anivahealth.com/de/embed/biomarkers/vitamin-d?theme=light\u0026#x26;primary=0f766e#token=eyJwdXJwb3NlIjoiZW1iZWRfbGF1bmNoIi4uLn0.k7Qm2V0sZ1yH\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"expires_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-11-19T20:17:43.000Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"route.name: Invalid discriminator value. Expected 'biomarkers' | 'biomarker' | 'twin'\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"403","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Access denied: profile is outside your permission scope\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"404","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Appointment not found\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"404 document","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Document not found\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create Embed Session","path":"/api/v1/profiles/{id}/embed-sessions","servers":[{"url":"https://anivahealth.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"x-api-key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"id":{"schema":[{"type":"string","description":"Unique identifier (UUID) of the profile whose results the page shows.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"language":[{"type":"string","description":"Page language: `en` , `bg` , `ca` , `cs` , `da` , `de` , `el` , `es` , `et` , `fi` , `fr` , `ga` , `hr` , `hu` , `is` , `it` , `lb` , `lt` , `lv` , `mt` , `nl` , `no` , `pl` , `pt` , `ro` , `ru` , `sk` , `sl` , `sr` , `sv` , `tr` or `uk` . Default: the language of the profile."}],"route":[{"type":"object","properties":{"name":[{"type":"string","description":"One of: `biomarkers` : the list of all biomarkers with their latest results. `biomarker` : the detail page of one biomarker, with its trend, ranges and explanation. Needs `biomarker_id` . `twin` : the 3D body with a grade per health area. The user selects an area to see its biomarkers.","required":true}],"biomarker_id":[{"type":"integer","description":"Only for `biomarker` . The `biomarker_id` of the biomarker, as in the results, for example `104` . Use the id, not the slug: a slug can change, the id stays."}]},"description":"The page that the URL opens. Default: `{ \"name\": \"biomarkers\" }` . Any other `name` returns `400` ."}],"report":[{"type":"object","properties":{"appointment_id":[{"type":"string","description":"The `id` of an appointment of the profile. Your key must have access to it, as for Get Lab Results . If it does not, this endpoint returns `404` , not `403` ."}],"home_kit_order_id":[{"type":"string","description":"The `id` of a home kit order of the profile. Your key must have access to it, as for Get Lab Results for home kit orders, and also needs `home_kit_orders_view` or `home_kit_orders_manage` ."}],"document_id":[{"type":"string","description":"The `id` of a lab report that you uploaded for the profile with Upload Document . Your key must have access to it, as for Get Document Results . If it does not, this endpoint returns `404` , not `403` . The page shows the date of the lab test, or the upload date when no value is read yet. While Aniva reads the document and has no value yet, every page tells the user to open it again in a few minutes."}]},"description":"Limits every page to one lab report of the profile. Default: all reports of the profile. Send exactly one of the three ids. The list, the trend of a biomarker and the twin then show the results of that report only, and the page hides the appointment filter. The user cannot open another report with this URL."}],"appearance":[{"type":"object","properties":{"theme":[{"type":"string","description":"`light` or `dark` . Default: the system setting of the device."}],"primary_color":[{"type":"string","description":"Hex colour of buttons and links, 3 or 6 digits, with or without `#` , for example `0f766e` . Default: the brand colour of your profile group, else Aniva orange. Buttons keep white text, so choose a dark colour."}],"show_logo":[{"type":"boolean","description":"Show the logo of your profile group above the results. Default: `true` ."}]},"description":"The look of the page. The API adds it to the URL as search params."}]}}],"examples":{"example":{"value":{"language":"\u003cstring>","route":{"name":"\u003cstring>","biomarker_id":123},"report":{"appointment_id":"\u003cstring>","home_kit_order_id":"\u003cstring>","document_id":"\u003cstring>"},"appearance":{"theme":"\u003cstring>","primary_color":"\u003cstring>","show_logo":true}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"url":[{"type":"string","description":"The page URL. The launch token is in the `#token=` fragment, so a browser never sends it to a server. Open it once.","required":true}],"expires_at":[{"type":"string","description":"ISO 8601 instant after which the URL cannot be opened.","required":true}]}}],"examples":{"example":{"value":{"url":"\u003cstring>","expires_at":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/anivahealth/5d0d870ff743f803/video-zoom.js"],"subdomain":"anivahealth","siteName":"Aniva API","title":"Create Embed Session - Aniva API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api/profiles/create-embed-session","matchLevel":0},"de":{"href":"/de/api/profiles/create-embed-session","matchLevel":1},"ca":{"href":"/ca/api/profiles/create-embed-session","matchLevel":1},"cs":{"href":"/cs/api/profiles/create-embed-session","matchLevel":1},"da":{"href":"/da/api/profiles/create-embed-session","matchLevel":1},"es":{"href":"/es/api/profiles/create-embed-session","matchLevel":1},"fi":{"href":"/fi/api/profiles/create-embed-session","matchLevel":1},"fr":{"href":"/fr/api/profiles/create-embed-session","matchLevel":1},"hu":{"href":"/hu/api/profiles/create-embed-session","matchLevel":1},"it":{"href":"/it/api/profiles/create-embed-session","matchLevel":1},"lv":{"href":"/lv/api/profiles/create-embed-session","matchLevel":1},"nl":{"href":"/nl/api/profiles/create-embed-session","matchLevel":1},"no":{"href":"/no/api/profiles/create-embed-session","matchLevel":1},"pl":{"href":"/pl/api/profiles/create-embed-session","matchLevel":1},"pt":{"href":"/pt/api/profiles/create-embed-session","matchLevel":1},"ro":{"href":"/ro/api/profiles/create-embed-session","matchLevel":1},"ru":{"href":"/ru/api/profiles/create-embed-session","matchLevel":1},"sv":{"href":"/sv/api/profiles/create-embed-session","matchLevel":1},"tr":{"href":"/tr/api/profiles/create-embed-session","matchLevel":1},"uk":{"href":"/uk/api/profiles/create-embed-session","matchLevel":1}}},"lastModified":"2026-11-21T23:49:03.512Z","originalFileLocation":"api/profiles/create-embed-session.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a one-time URL that shows a profile\u0026#x27;s lab results inside your app\">\u003cmeta data-mint-head name=\"keywords\" content=\"blood test API, lab testing API, home test kit API, lab results API, biomarker API, pharmacy blood test, Germany, EU\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aniva API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Embed Session - Aniva API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a one-time URL that shows a profile\u0026#x27;s lab results inside your app\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aniva Partner API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.anivahealth.com/api/profiles/create-embed-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://anivahealth.mintlify.site/_mintlify/api/og/v2?division=Profiles\u0026amp;title=Create+Embed+Session\u0026amp;description=Get+a+one-time+URL+that+shows+a+profile%27s+lab+results+inside+your+app\u0026amp;theme=ee63c32abd41d12dcedcfed1\u0026amp;signature=1bbe184eddbfd7c5461225f0a6fdce33223013133b4d4065d3594c2632512d4d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Embed Session - Aniva API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a one-time URL that shows a profile\u0026#x27;s lab results inside your app\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://anivahealth.mintlify.site/_mintlify/api/og/v2?division=Profiles\u0026amp;title=Create+Embed+Session\u0026amp;description=Get+a+one-time+URL+that+shows+a+profile%27s+lab+results+inside+your+app\u0026amp;theme=ee63c32abd41d12dcedcfed1\u0026amp;signature=1bbe184eddbfd7c5461225f0a6fdce33223013133b4d4065d3594c2632512d4d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aniva API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e76c2b\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.anivahealth.com/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/profiles/create-embed-session.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.anivahealth.com/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.anivahealth.com/de/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.anivahealth.com/ca/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"cs\" href=\"https://docs.anivahealth.com/cs/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"da\" href=\"https://docs.anivahealth.com/da/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.anivahealth.com/es/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fi\" href=\"https://docs.anivahealth.com/fi/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.anivahealth.com/fr/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hu\" href=\"https://docs.anivahealth.com/hu/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.anivahealth.com/it/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"lv\" href=\"https://docs.anivahealth.com/lv/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"nl\" href=\"https://docs.anivahealth.com/nl/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"no\" href=\"https://docs.anivahealth.com/no/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pl\" href=\"https://docs.anivahealth.com/pl/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.anivahealth.com/pt/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ro\" href=\"https://docs.anivahealth.com/ro/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.anivahealth.com/ru/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"sv\" href=\"https://docs.anivahealth.com/sv/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"tr\" href=\"https://docs.anivahealth.com/tr/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"uk\" href=\"https://docs.anivahealth.com/uk/api/profiles/create-embed-session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.anivahealth.com/api/profiles/create-embed-session\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.anivahealth.com/#organization\",\"name\":\"Aniva API\",\"url\":\"https://docs.anivahealth.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.anivahealth.com#website\",\"name\":\"Aniva API\",\"url\":\"https://docs.anivahealth.com\",\"publisher\":{\"@id\":\"https://docs.anivahealth.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.anivahealth.com/api/profiles/create-embed-session#webpage\",\"url\":\"https://docs.anivahealth.com/api/profiles/create-embed-session\",\"name\":\"Create Embed Session\",\"description\":\"Get a one-time URL that shows a profile's lab results inside your app\",\"dateModified\":\"2026-11-21T23:49:03.512Z\",\"isPartOf\":{\"@id\":\"https://docs.anivahealth.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.anivahealth.com/api/profiles/create-embed-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.anivahealth.com/api/profiles/create-embed-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Profiles\",\"item\":\"https://docs.anivahealth.com/api/profiles/list-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Embed Session\",\"item\":\"https://docs.anivahealth.com/api/profiles/create-embed-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.anivahealth.com/api/profiles/create-embed-session#apireference\",\"headline\":\"Create Embed Session\",\"name\":\"Create Embed Session\",\"description\":\"Get a one-time URL that shows a profile's lab results inside your app\",\"url\":\"https://docs.anivahealth.com/api/profiles/create-embed-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.anivahealth.com/api/profiles/create-embed-session#webpage\"},\"dateModified\":\"2026-11-21T23:49:03.512Z\",\"publisher\":{\"@id\":\"https://docs.anivahealth.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.anivahealth.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aniva API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Aniva API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/profiles/create-embed-session.md","siteName":"Aniva API","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Health","pages":[{"title":"Health Check","api":"GET https://anivahealth.com/api/v1/health","href":"/api/health/check-health"}]},{"group":"Profiles","pages":[{"title":"List Profiles","api":"GET https://anivahealth.com/api/v1/profiles","href":"/api/profiles/list-profiles"},{"title":"Create Profile","api":"POST https://anivahealth.com/api/v1/profiles","href":"/api/profiles/create-profile"},{"title":"Get Profile","api":"GET https://anivahealth.com/api/v1/profiles/{id}","href":"/api/profiles/get-profile"},{"title":"Update Profile","description":"Update an existing patient profile","api":"PATCH https://anivahealth.com/api/v1/profiles/{id}","href":"/api/profiles/update-profile"},{"title":"Create Embed Session","api":"POST https://anivahealth.com/api/v1/profiles/{id}/embed-sessions","href":"/api/profiles/create-embed-session"}]},{"group":"Appointments","pages":[{"title":"List Appointments","description":"Retrieve blood draw appointments accessible to your API key","api":"GET https://anivahealth.com/api/v1/appointments","href":"/api/appointments/list-appointments"},{"title":"Create Appointment","api":"POST https://anivahealth.com/api/v1/appointments","href":"/api/appointments/create-appointment"},{"title":"Get Appointment","api":"GET https://anivahealth.com/api/v1/appointments/{id}","href":"/api/appointments/get-appointment"},{"title":"Update Appointment","api":"PATCH https://anivahealth.com/api/v1/appointments/{id}","href":"/api/appointments/update-appointment"},{"title":"Cancel Appointment","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}","href":"/api/appointments/cancel-appointment"},{"title":"Add Panels","api":"POST https://anivahealth.com/api/v1/appointments/{id}/panels","href":"/api/appointments/add-panels"},{"title":"Remove Panels","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}/panels","href":"/api/appointments/remove-panels"},{"title":"Add Individual Biomarkers","api":"PATCH https://anivahealth.com/api/v1/appointments/{id}/biomarkers","href":"/api/appointments/add-individual-biomarkers"},{"title":"Remove Individual Biomarkers","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}/biomarkers","href":"/api/appointments/remove-individual-biomarkers"},{"title":"Preview Appointment","api":"GET https://anivahealth.com/api/v1/appointments/{id}/preview","href":"/api/appointments/preview-containers"},{"title":"Confirm Blood Draw","api":"POST https://anivahealth.com/api/v1/appointments/{id}/confirm","href":"/api/appointments/confirm-blood-draw"},{"title":"Get Lab Results","api":"GET https://anivahealth.com/api/v1/appointments/{id}/results","href":"/api/appointments/get-results"},{"title":"Email Results","api":"POST https://anivahealth.com/api/v1/appointments/{id}/results/email","href":"/api/appointments/email-results"}]},{"group":"Home Kit Orders","pages":[{"title":"List Home Kit Orders","api":"GET https://anivahealth.com/api/v1/home-kit-orders","href":"/api/home-kit-orders/list-home-kits"},{"title":"Create Home Kit Order","api":"POST https://anivahealth.com/api/v1/home-kit-orders","href":"/api/home-kit-orders/create-home-kit"},{"title":"Get Home Kit Order","api":"GET https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/api/home-kit-orders/get-home-kit"},{"title":"Update Home Kit Order","api":"PATCH https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/api/home-kit-orders/update-home-kit"},{"title":"Cancel Home Kit Order","api":"DELETE https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/api/home-kit-orders/cancel-home-kit"},{"title":"Activate Home Kit Order","api":"POST https://anivahealth.com/api/v1/home-kit-orders/{id}/activate","href":"/api/home-kit-orders/activate-home-kit"},{"title":"Add Individual Biomarkers","api":"PATCH https://anivahealth.com/api/v1/home-kit-orders/{id}/biomarkers","href":"/api/home-kit-orders/add-individual-biomarkers"},{"title":"Remove Individual Biomarkers","api":"DELETE https://anivahealth.com/api/v1/home-kit-orders/{id}/biomarkers","href":"/api/home-kit-orders/remove-individual-biomarkers"},{"title":"Get Lab Results","api":"GET https://anivahealth.com/api/v1/home-kit-orders/{id}/results","href":"/api/home-kit-orders/get-results"},{"title":"Email Results","api":"POST https://anivahealth.com/api/v1/home-kit-orders/{id}/results/email","href":"/api/home-kit-orders/email-results"}]},{"group":"Test catalog","pages":[{"title":"List Biomarkers","api":"GET https://anivahealth.com/api/v1/biomarkers","href":"/api/biomarkers/list-biomarkers"},{"title":"Get Biomarker","api":"GET https://anivahealth.com/api/v1/biomarkers/{id}","href":"/api/biomarkers/get-biomarker"},{"title":"List Panels","api":"GET https://anivahealth.com/api/v1/panels","href":"/api/panels/list-panels"}]},{"group":"Pricing","pages":[{"title":"Get Rate Card","api":"GET https://anivahealth.com/api/v1/pricing/rate-card","href":"/api/pricing/get-rate-card"},{"title":"Quote Cart","api":"POST https://anivahealth.com/api/v1/pricing/quote","href":"/api/pricing/quote-cart"}]},{"group":"Units","pages":[{"title":"List Units","api":"GET https://anivahealth.com/api/v1/units","href":"/api/units/list-units"}]},{"group":"Locations","pages":[{"title":"List Locations","api":"GET https://anivahealth.com/api/v1/locations","href":"/api/locations/list-locations"},{"title":"Get Location","api":"GET https://anivahealth.com/api/v1/locations/{id}","href":"/api/locations/get-location"},{"title":"Get Availability","api":"GET https://anivahealth.com/api/v1/locations/{id}/availability","href":"/api/locations/get-availability"},{"title":"List Retail Prices","api":"GET https://anivahealth.com/api/v1/locations/retail-prices","href":"/api/locations/list-retail-prices"},{"title":"Get Retail Prices","api":"GET https://anivahealth.com/api/v1/locations/{id}/retail-prices","href":"/api/locations/get-retail-prices"}]},{"group":"Documents","pages":[{"title":"Upload Document","api":"POST https://anivahealth.com/api/v1/documents","href":"/api/documents/upload-document"},{"title":"Get Document Results","api":"GET https://anivahealth.com/api/v1/documents/{id}/results","href":"/api/documents/get-document-results"},{"title":"Download Document","api":"GET https://anivahealth.com/api/v1/documents/{id}","href":"/api/documents/download-document"},{"title":"Delete Document","api":"DELETE https://anivahealth.com/api/v1/documents/{id}","href":"/api/documents/delete-document"}]},{"group":"Shipments","pages":[{"title":"Create Shipment","api":"POST https://anivahealth.com/api/v1/shipments","href":"/api/shipments/create-shipment"},{"title":"List Shipments","api":"GET https://anivahealth.com/api/v1/shipments","href":"/api/shipments/list-shipments"},{"title":"Get Shipment","api":"GET https://anivahealth.com/api/v1/shipments/{id}","href":"/api/shipments/get-shipment"},{"title":"Update Shipment","api":"PATCH https://anivahealth.com/api/v1/shipments/{id}","href":"/api/shipments/update-shipment"},{"title":"Cancel Shipment","api":"DELETE https://anivahealth.com/api/v1/shipments/{id}","href":"/api/shipments/cancel-shipment"},{"title":"List Shipment Appointments","api":"GET https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/api/shipments/list-shipment-appointments"},{"title":"Attach Appointments to Shipment","api":"POST https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/api/shipments/attach-appointments-to-shipment"},{"title":"Detach Appointments from Shipment","api":"DELETE https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/api/shipments/detach-appointments-from-shipment"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","api":"GET https://anivahealth.com/api/v1/webhooks","href":"/api/webhooks/list-webhooks"},{"title":"Create Webhook","api":"POST https://anivahealth.com/api/v1/webhooks","href":"/api/webhooks/create-webhook"},{"title":"Get Webhook","api":"GET https://anivahealth.com/api/v1/webhooks/{id}","href":"/api/webhooks/get-webhook"},{"title":"Update Webhook","api":"PATCH https://anivahealth.com/api/v1/webhooks/{id}","href":"/api/webhooks/update-webhook"},{"title":"Delete Webhook","api":"DELETE https://anivahealth.com/api/v1/webhooks/{id}","href":"/api/webhooks/delete-webhook"},{"title":"Rotate Secret","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/rotate-secret","href":"/api/webhooks/rotate-secret"},{"title":"Send Test Event","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/ping","href":"/api/webhooks/send-test-event"},{"title":"List Deliveries","api":"GET https://anivahealth.com/api/v1/webhooks/{id}/deliveries","href":"/api/webhooks/list-deliveries"},{"title":"Resend Delivery","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/deliveries/{delivery_id}/resend","href":"/api/webhooks/resend-delivery"}]}]}]},{"language":"de","navbar":{"links":[{"href":"/de/changelog","label":"Changelog"},{"href":"/de/status","label":"Status"}]},"pages":[{"title":"de","href":"/de/api/profiles/create-embed-session"}]},{"language":"ca","navbar":{"links":[{"href":"/ca/changelog","label":"Registre de canvis"},{"href":"/ca/status","label":"Estat"}]},"pages":[{"title":"ca","href":"/ca/api/profiles/create-embed-session"}]},{"language":"cs","navbar":{"links":[{"href":"/cs/changelog","label":"Seznam změn"},{"href":"/cs/status","label":"Stav"}]},"pages":[{"title":"cs","href":"/cs/api/profiles/create-embed-session"}]},{"language":"da","navbar":{"links":[{"href":"/da/changelog","label":"Ændringslog"},{"href":"/da/status","label":"Status"}]},"pages":[{"title":"da","href":"/da/api/profiles/create-embed-session"}]},{"language":"es","navbar":{"links":[{"href":"/es/changelog","label":"Registro de cambios"},{"href":"/es/status","label":"Estado"}]},"pages":[{"title":"es","href":"/es/api/profiles/create-embed-session"}]},{"language":"fi","navbar":{"links":[{"href":"/fi/changelog","label":"Muutosloki"},{"href":"/fi/status","label":"Tila"}]},"pages":[{"title":"fi","href":"/fi/api/profiles/create-embed-session"}]},{"language":"fr","navbar":{"links":[{"href":"/fr/changelog","label":"Journal des modifications"},{"href":"/fr/status","label":"Statut"}]},"pages":[{"title":"fr","href":"/fr/api/profiles/create-embed-session"}]},{"language":"hu","navbar":{"links":[{"href":"/hu/changelog","label":"Változásnapló"},{"href":"/hu/status","label":"Állapot"}]},"pages":[{"title":"hu","href":"/hu/api/profiles/create-embed-session"}]},{"language":"it","navbar":{"links":[{"href":"/it/changelog","label":"Changelog"},{"href":"/it/status","label":"Stato"}]},"pages":[{"title":"it","href":"/it/api/profiles/create-embed-session"}]},{"language":"lv","navbar":{"links":[{"href":"/lv/changelog","label":"Izmaiņu žurnāls"},{"href":"/lv/status","label":"Statuss"}]},"pages":[{"title":"lv","href":"/lv/api/profiles/create-embed-session"}]},{"language":"nl","navbar":{"links":[{"href":"/nl/changelog","label":"Changelog"},{"href":"/nl/status","label":"Status"}]},"pages":[{"title":"nl","href":"/nl/api/profiles/create-embed-session"}]},{"language":"no","navbar":{"links":[{"href":"/no/changelog","label":"Endringslogg"},{"href":"/no/status","label":"Status"}]},"pages":[{"title":"no","href":"/no/api/profiles/create-embed-session"}]},{"language":"pl","navbar":{"links":[{"href":"/pl/changelog","label":"Dziennik zmian"},{"href":"/pl/status","label":"Status"}]},"pages":[{"title":"pl","href":"/pl/api/profiles/create-embed-session"}]},{"language":"pt","navbar":{"links":[{"href":"/pt/changelog","label":"Registo de alterações"},{"href":"/pt/status","label":"Estado"}]},"pages":[{"title":"pt","href":"/pt/api/profiles/create-embed-session"}]},{"language":"ro","navbar":{"links":[{"href":"/ro/changelog","label":"Jurnal de modificări"},{"href":"/ro/status","label":"Stare"}]},"pages":[{"title":"ro","href":"/ro/api/profiles/create-embed-session"}]},{"language":"ru","navbar":{"links":[{"href":"/ru/changelog","label":"История изменений"},{"href":"/ru/status","label":"Статус"}]},"pages":[{"title":"ru","href":"/ru/api/profiles/create-embed-session"}]},{"language":"sv","navbar":{"links":[{"href":"/sv/changelog","label":"Ändringslogg"},{"href":"/sv/status","label":"Status"}]},"pages":[{"title":"sv","href":"/sv/api/profiles/create-embed-session"}]},{"language":"tr","navbar":{"links":[{"href":"/tr/changelog","label":"Değişiklik günlüğü"},{"href":"/tr/status","label":"Durum"}]},"pages":[{"title":"tr","href":"/tr/api/profiles/create-embed-session"}]},{"language":"uk","navbar":{"links":[{"href":"/uk/changelog","label":"Історія змін"},{"href":"/uk/status","label":"Статус"}]},"pages":[{"title":"uk","href":"/uk/api/profiles/create-embed-session"}]}]},"basePath":"","title":"Create Embed Session - Aniva API","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","b0f84f53ff","2b790eda92"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","Page-DuqezyvM.js","CodeSnippet-B373COAT.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","getApiPlaygroundDisplay-CfL-UuDS.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js"]}