Overview
This guide walks you through making your first API calls to Alto Health. You’ll upload a medical referral document and trigger automated pathway execution to process it.Prerequisites:
- Your Alto Health API credentials (organization ID, platform API key, authentication token)
- A sample medical document (PDF or image)
- A configured pathway in your Alto Health account
- Basic knowledge of REST APIs
Two Ways to Process Documents
Alto Health offers two approaches for processing documents:Run Automation Automatically (Recommended - Fastest)
Run Automation Automatically (Recommended - Fastest)
What it does: Upload your document and Alto Health automatically processes everything.Steps required:
- Upload document
- Wait for results (via webhook or polling)
Run Automation Manually
Run Automation Manually
What it does: Upload your document, then explicitly trigger automation via API call.Steps required:
- Upload document
- Call the automation endpoint manually
- Wait for results (via webhook or polling)
This quickstart shows the Manual approach to demonstrate all available API endpoints. For the autonomous approach, simply skip Step 2 after uploading your document.
Complete Workflow
We’ll build a simple workflow that:- Uploads a medical referral document
- (Optional - Manual only) Triggers automated pathway execution
- Receives results via webhook or polling
Workflow Overview
Autonomous (Green path): Fastest approach - upload and Alto Health automatically handles extraction, rules, and actions.Manual (Yellow path): Upload, then explicitly trigger automation for more control.Get results via:
- Webhook (Recommended): Alto Health automatically sends results to your endpoint when processing completes
- Polling: Your service periodically checks the status endpoint until completion
Step 1: Upload a Document
Upload a medical referral document to Alto Health using the Upload Document endpoint.Upload Document
See complete endpoint documentation with code examples in Python, JavaScript, cURL, and C#
Using Autonomous mode? You’re done! Alto Health will automatically process your document. Skip to “What Happens Next?” to learn how to receive your results via webhook or polling.
Step 2: Run Automation Manually (Optional)
Trigger the automated pathway to process the document using the record ID from Step 1.Run Automation Manually
See complete endpoint documentation with code examples and pathway types
The pathway executes asynchronously. Results will be delivered via:
- Webhook (if configured) - Alto Health POSTs results to your endpoint
- Polling - Query the status endpoint periodically
What Happens Next?
After uploading your document (and optionally triggering automation manually):-
Automated Processing - Alto Health automatically:
- Extracts clinical data from the document
- Evaluates rules and conditions based on your configured pathways
- Executes configured actions (notifications, routing, triage recommendations, etc.)
- Updates record status
-
Receive Results - Choose your preferred method:
- Webhook (Recommended): Configure a webhook URL to receive automatic notifications when processing completes
- Polling: Query your system to check pathway completion status
