Skip to main content

​
Data & Exports API Reference

Complete reference for all data export endpoints in the Voyager API.

​
GET /api/v2/data/

Get data object details.

​
Path Parameters

ParameterTypeDescription
idstring (UUID)Data object ID

​
GET /api/v2/data//view

Get or generate a data view (downsampled volume data).

​
Query Parameters

ParameterTypeDescription
outputFormatstringOutput format: “nrrd”, “raw”, or “tiff”
max_voxel_countintegerMaximum number of voxels
max_dimension_sizeintegerMaximum dimension size (default: 2048)
mapped_percentile_rangearrayIntensity mapping range [min, max]
skip_normalizationbooleanSkip normalization

​
Response

{
  "id": "data-view-uuid",
  "data": "https://download-url...",
  "parameters": {...},
  "version": 1
}

​
Example

  • Python
response = requests.get(
    f"{api_url}/api/v2/data/{data_object_id}/view",
    headers=headers,
    params={
        "outputFormat": "nrrd",
        "max_voxel_count": 100000000
    }
)
data_view = response.json()
download_url = data_view["data"]

​
GET /api/v2/data//resolution

Get data resolution information.

​
POST /api/v2/projects//export

Request a project export.

​
Request Body

{
  "config": {
    "exportMeshes": true,
    "exportVolumes": true,
    "exportRadiographs": true
  },
  "sendToRequester": false
}

​
GET /api/v2/projects//export

Get project export status and download URL.

​
Response

{
  "id": "export-uuid",
  "url": "https://download-url...",
  "exportGenerationTime": "2024-01-15T10:30:00Z"
}

​
GET /api/v2/export//

Get download URL for a specific export file.

​
Path Parameters

ParameterTypeDescription
idstring (UUID)Data object ID
fileNamestringFile name to download

​
Response

{
  "url": "https://pre-signed-download-url..."
}
For detailed guides, see Data Export Guide.