AIVA Documentation Hub :: Developer & Integration Documentation

Guides

Use the guides below for project definitions, package files and Authorization Server integration. Each reference includes implementation details and practical examples.

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/report.json, source data files, examples, templates, and package validation rules.

Open Guide

OAuth / OpenID ConnectBETA

AIVA Authorization

Integrate approved confidential clients with AIVA-hosted user sign-in. Includes Authorization Code + S256 PKCE, token exchange and refresh, scopes, validation, practical .NET/cURL examples and troubleshooting.

Open Guide

ReportBETA

Report Specification Contract

Defines the report.json contract for selecting report templates and associating packaged source data with each generated report.

Open Guide

Where to start

AIVA project definitions use two related document types: a Blueprint for visualisation and an AIVA Package for bundling data and definitions. AIVA Authorization documents how approved external integrations authenticate an existing AIVA user before making API calls.

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.
Authenticate an integration or exchange AIVA OAuth tokens	AIVA Authorization BETA	Client onboarding, S256 PKCE, authorization-code flow, refresh tokens, scopes, token validation and integration troubleshooting.
Create or validate `report.json`	Report Specification Contract	Report structure, template selection, source data directories, examples, and available report templates.

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. Use the AIVA Authorization guide for user-delegated OAuth/OIDC integration (currently in beta).