API how-to index (tutorials)

Use APIs to automate workflows and integrate with external systems.

Use APIs to automate workflows and integrate with external systems.

You can also:


Authentication and service accounts

Topic Description Interface Documentation Video
Authenticate to the APIs Authenticate requests to the platform API Documentation
Set up a service account Configure service account for integrations Portal Documentation Video
Call API endpoints Use API endpoints programmatically API Documentation

Structured data

Topic Description Interface Documentation Video
Query structured data Query structured datasets API Documentation

File storage

Topic Description Interface Documentation Video
Upload files Upload unstructured files API Documentation
Download files Download unstructured files API Documentation

Workflow jobs

Topic Description Interface Documentation Video
Workflow jobs overview Overview of workflow jobs API Documentation
List available jobs Retrieve available jobs API Documentation
Run a job Trigger a workflow job API Documentation
View job history Retrieve job execution history API Documentation

Asset Model

Asset Registry

Topic Description Interface Documentation Video
Asset Registry overview Overview of asset registry API Documentation
Get root systems Retrieve root systems API Documentation
Get all subsystems of a system Retrieve subsystem hierarchy API Documentation
Edit properties Modify asset properties API Documentation
Edit signals Modify asset signals API Documentation

Taxonomy and system models

Topic Description Interface Documentation Video
Taxonomy overview Overview of taxonomy model API Documentation
Add a system model Create a system model API Documentation
Edit a system model Modify a system model API Documentation
Publish a new version Publish updated model version API Documentation
Create a blueprint Create a blueprint API Documentation