Getting started

What the VitalView AI Vendor API does, the five-step study lifecycle from upload 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 and JSON. Every request is authenticated with the X-API-Key header. See Authentication.

The study lifecycle

A study moves through five steps:

Create the study with POST /studies. You describe the files you will send and receive presigned upload URLs.
Upload the DICOM files directly to the presigned URLs with HTTP PUT. Files never pass through our API servers.
Start processing with POST /studies/{study_id}/process. We detect the DICOM series, pick the best one (or use the one you specify), and dispatch the study to the GPU pipeline.
Poll status with GET /studies/{study_id} until status is complete. Typical turnaround is under two minutes once processing starts.
Fetch results: GET /studies/{study_id}/report, /findings, and /images.

Status	Meaning
`uploaded`	Study created, waiting for `process`
`queued`	Dispatched, waiting for a GPU worker
`materializing`	DICOM to volume conversion in progress
`processing`	AI pipeline running
`complete`	Results available
`error`	Processing failed, see the `error` field

Quickstart

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

# 1. Create a study
curl -s -X POST "$API/studies" \
  -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d '{
    "scan_type": "ct_brain",
    "files": [{"filename": "study.zip", "size_mb": 84.2}],
    "patient": {"name": "DOE^JANE", "dob": "1980-01-01", "sex": "F"},
    "clinical_indication": "Fall with loss of consciousness",
    "vendor_ref": "ACC-2231"
  }'
# -> { "study_id": "a1b2c3d4", "upload": { "urls": [{ "url": "https://..." }] } }

# 2. Upload the file (no auth header, the URL is self-signed)
curl -s -X PUT --upload-file study.zip "$UPLOAD_URL"

# 3. Start processing
curl -s -X POST "$API/studies/a1b2c3d4/process" -H "X-API-Key: $KEY"

# 4. Poll until complete
curl -s "$API/studies/a1b2c3d4" -H "X-API-Key: $KEY"

# 5. Fetch the report
curl -s "$API/studies/a1b2c3d4/report" -H "X-API-Key: $KEY"

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