Getting started

What the VitalView AI Vendor API does, the three-step study lifecycle from submit to signed report, and a five-minute quickstart with real request examples.

The VitalView AI Vendor API lets a PACS, RIS, or teleradiology platform send emergency CT studies for AI screening and receive everything a radiologist needs to review, edit, and sign a report: the draft report text, structured findings, and the key images that support each finding.

Base URL

https://api.vitalview.ai/v1

All requests use HTTPS. The submit is multipart form data; everything else is JSON. Every request is authenticated with the X-API-Key header. See Authentication.

The study lifecycle

Three steps:

1. Submit the study with POST /studies: the DICOM .zip (or one .dcm) and its metadata in one multipart request. We store it, detect the DICOM series, pick the best one (or use the one you specify), and start the read. The response is the study object with status: queued.
2. Receive the callback at the HTTPS callback_url supplied at submission. We POST the finished study with event: "study.completed", including failed reads. Verify the signature before accepting it; see Retrieve results. Turnaround scales with the number of slices.
3. Read the result from the callback payload: once complete it carries the report, its findings and impression, and the key images, each with the DICOM slice it shows.

Quickstart

export KEY="vv_live_..."   # issued by VitalView AI
export API="https://api.vitalview.ai/v1"

# 1. Submit the study: upload and start the read in one request
curl -s -X POST "$API/studies" \
  -H "X-API-Key: $KEY" \
  -F "file=@study.zip" \
  -F "scan_type=ct_brain" \
  -F "patient[name]=DOE^JANE" -F "patient[dob]=1980-01-01" -F "patient[gender]=F" \
  -F "clinical_indication=Fall with loss of consciousness" \
  -F "callback_url=https://your-host.example/vitalview-hook"
# -> { "study_id": "a1b2c3d4", "status": "queued", ... }

# 2. Your HTTPS endpoint receives the finished study (verify its signature)
# -> { "event": "study.completed", "status": "complete", "report": { "markdown": "...", "findings": "...", "impression": "...", "figures": [ ... ] } }

# Optional: the report as a standalone HTML page
curl -s "$API/studies/a1b2c3d4/report.html" -H "X-API-Key: $KEY" -o report.html

Interactive reference

A complete OpenAPI reference with request and response schemas is available at api.vitalview.ai/v1/docs.

Clinical scope

VitalView AI produces preliminary draft reports intended for review by qualified clinicians. Findings are advisory: the radiologist edits and signs the final report in your system, and remains responsible for the final decision.

Next: Authentication