Skip to main content

​
Quick Start Guide

Get up and running with the Voyager API in just a few minutes. This guide will walk you through authenticating and making your first API call.

​
Step 1: Get Your API Credentials

You’ll need:
  • Your Voyager account email
  • Your Voyager account password
  • Your API base URL (cloud customers use https://voyager.lumafield.com)
If you don’t have API access enabled, contact support@lumafield.com to request access.

​
Step 2: Install the Python Client (Optional)

While you can use any HTTP client, we provide a Python client for convenience: 
pip install requests
Or clone our API client repository: 
git clone <repository-url>
cd api_module

​
Step 3: Authenticate

Authenticate with the API to get your access token:
  • Python
  • curl
import requests

api_url = "https://voyager.lumafield.com"
email = "your-email@company.com"
password = "your-password"

# Authenticate
response = requests.post(
    f"{api_url}/api/login",
    json={"email": email, "password": password}
)
response.raise_for_status()

token = response.json()["token"]
print(f"Authenticated! Token: {token[:20]}...")

​
Step 4: Make Your First Request

Now let’s list your projects:
  • Python
  • curl
# Use the token from Step 3
headers = {
    "Authorization": f"Token {token}",
    "Content-Type": "application/json"
}

# List projects
response = requests.get(
    f"{api_url}/api/v2/projects",
    headers=headers
)
response.raise_for_status()

projects = response.json()
print(f"Found {projects['count']} projects")

# Print first project
if projects['results']:
    first_project = projects['results'][0]
    print(f"First project: {first_project['name']} (ID: {first_project['id']})")

​
Step 5: Get Project Details

Let’s get more information about a specific project:
  • Python
  • curl
# Replace with your project ID
project_id = "your-project-uuid"

response = requests.get(
    f"{api_url}/api/v2/projects/{project_id}",
    headers=headers
)
response.raise_for_status()

project = response.json()
print(f"Project: {project['name']}")
print(f"Status: {project['status']}")
print(f"Created: {project['created_at']}")

​
Using the Python Client

If you’re using our Python client, the code is even simpler: 
from api_client import LumafieldAPIClient

# Initialize client (handles authentication automatically)
client = LumafieldAPIClient(
    api_url="https://voyager.lumafield.com",
    email="your-email@company.com",
    password="your-password"
)

# List projects
projects = client.list_projects()
print(f"Found {projects['count']} projects")

# Get project details
project = client.get_project("your-project-uuid")
print(f"Project: {project['name']}")

​
What’s Next?

Now that you’ve made your first API calls, explore these next steps:
  1. Authentication Guide - Learn more about authentication methods and token management
  2. Project Management Guide - Learn how to create, update, and organize projects
  3. Data Export Guide - Export your CT scan data
  4. API Reference - Complete reference for all endpoints

​
Common Issues

​
Authentication Failed

  • Verify your email and password are correct
  • Ensure your account has API access enabled
  • Check that you’re using the correct API base URL

​
No Projects Found

  • Make sure you have projects in your Voyager account
  • Check that you’re authenticated with the correct account
  • Verify workspace permissions if using workspace filtering

​
Rate Limits

  • The API has rate limits to prevent abuse
  • If you hit rate limits, implement delays between requests
  • Contact support if you need higher limits

​
Need Help?