AIVA AIVA documentation Documentation hub
Documentation hub

AIVA Documentation Hub

Find the right reference for AIVA Blueprint JSON files and .aivapkg packages. Each guide contains its own schema reference, template section, validation rules, and examples.

Guides

Use the guides below as the main references for AIVA project definitions and package files. The schema, template, validation, and example material is included directly inside each guide.

Blueprint

Blueprint Developer Contract

Defines the JSON contract for project identity, data sources, colour maps, scenes, tracks, curves, regions, statistics, 3D display, examples, templates, and validation rules.

Open Guide
AIVA Package

AIVA Package Reference

Defines the .aivapkg package format, including archive structure, manifest.json, blueprint.json, source data files, examples, templates, and package validation rules.

Open Guide

Where to start

AIVA uses two related document types. A Blueprint describes the visualisation project. An AIVA Package describes how that Blueprint and its source data files are bundled for upload.

If you need to... Use this guide What you will find there
Create or validate blueprint.json Blueprint Developer Contract Project structure, data sources, scenes, tracks, curves, ranges, display options, schema rules, templates, and examples.
Create or validate a .aivapkg archive AIVA Package Reference Package archive structure, manifest rules, source file layout, package-level validation, schema rules, templates, and examples.
Choosing the right guide

Use the Blueprint guide for the contents of blueprint.json. Use the AIVA Package guide for the upload package wrapper, manifest, archive layout, and how the Blueprint and source data files fit together.