Make your first API call
A worked example using curl to list clusters, submit a job, and poll submission status.
This guide walks through a complete API workflow: authenticate, list clusters, submit a job, and poll submission status, all using curl.
Set the key as an environment variable for convenience:
export VANTAGE_API_KEY=YOUR_API_KEY
export BASE=https://api.vantage.omnivector.solutions/v1
List clusters
curl -s -H "Authorization: Bearer $VANTAGE_API_KEY" \
"$BASE/reference/clusters" | jq '.[] | {name, status, provider}'
Note the cluster name you want to target.
List job scripts
curl -s -H "Authorization: Bearer $VANTAGE_API_KEY" \
"$BASE/reference/jobs/scripts" | jq '.[] | {id, name}'
Note the script id you want to submit.
Submit a job
curl -s -X POST \
-H "Authorization: Bearer $VANTAGE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"script_id": "SCRIPT_ID",
"cluster": "CLUSTER_NAME",
"partition": "compute",
"name": "api-test-job"
}' \
"$BASE/reference/jobs/submissions" | jq .
Success looks like this: the API returns a 200 response with the expected data, confirming authentication and connectivity are working.
The response includes a submission id. Copy it.
Poll submission status
curl -s -H "Authorization: Bearer $VANTAGE_API_KEY" \
"$BASE/reference/jobs/submissions/SUBMISSION_ID" | jq '{status, started_at, completed_at}'
The status field progresses through Pending, Running, and Completed (or Failed).
tip
For production workflows, use the Vantage SDK instead of raw curl calls. The SDK handles pagination, retries, and typed responses.