Flojoy

API Reference

Hardware

Create hardware

Get all hardware

Get hardware

Delete hardware

Swap hardware component

Get revisions

Measurements

Create measurement

Get all measurements by test id

Get all measurements by hardware id

Get measurement

Delete measurement

Models

Create model

Get all models

Get model

Delete model

Projects

Create project

Get all projects

Get project

Update project

Delete project

Add hardware to project

Remove hardware from project

Set project hardware

Test

Create test

Get all tests by project id

Get test

Update test

Delete test

SDKs

Python

Flojoy Cloud API

Flojoy Cloud

Welcome to the Flojoy Cloud API Reference!To get started, you&apos;ll want to sign up for a <a href="https://cloud.flojoy.ai/" target="_self">Flojoy Cloud</a> account. Then, you&apos;ll want to setup a workspace and create a workspace secret (this acts as an API key). Before you can create measurements, you&apos;ll want to create:<ul class="slate-ul"><li class="slate-li"><div style="position:relative">Hardware models representing the types of hardware under test</div></li><li class="slate-li"><div style="position:relative">Hardware instances representing the physical devices being tested</div></li><li class="slate-li"><div style="position:relative">A project for organizing a collection of devices with the same model being tested</div></li><li class="slate-li"><div style="position:relative">Tests within that project to define your test suite.</div></li></ul>

Welcome to the Flojoy Cloud API Reference!

To get started, you'll want to sign up for a 

 account. Then, you'll want to setup a workspace and create a workspace secret (this acts as an API key). 

Before you can create measurements, you'll want to create:

Hardware represents a physical instance of a hardware device, belonging to a specific model.Devices can either be standalone or be composed of multiple components.

Hardware represents a physical instance of a hardware device, belonging to a specific model.

Devices can either be standalone or be composed of multiple components.

Create a hardware device, optionally specifying the components by passing an array of hardware IDs.

Create a hardware device, optionally specifying the components by passing an array of hardware IDs.

name

workspaceId

modelId

components

projectId

createdAt

updatedAt

message

code

issues

Get every hardware device.

Only return hardware devices in this project.

Only return hardware devices of this model.

Only return hardware that is not currently being used in a system.

onlyAvailable

model

projects

Get a single hardware device and a tree of all its components.

Get a single hardware device and a tree of all its components.

hardwareId

modelName

Delete a hardware device.

Swap out a component in a hardware device for another one.This adds an add revision and a remove revision in the hardware device&apos;s revision history.

Swap out a component in a hardware device for another one.

This adds an add revision and a remove revision in the hardware device's revision history.

oldHardwareComponentId

newHardwareComponentId

reason

Get the revision history for this device.

Get the revision history for this device.

revisionType

componentId

userId

componentName

userEmail

A measurement is measured data produced by a hardware device.Currently, the supported data types are Boolean, DataFrame (pandas), and Scalar (int or float).Measurements are uploaded to tests,

A measurement is measured data produced by a hardware device.

, and each measurement can be assigned a 

 value indicating whether or not the device is passed the test. The pass value can be 

A model defines a schema for hardware instances.Models can represent a type of standalone device if they have no components.Models with components specify a list of other models with their respective counts.

A model defines a schema for hardware instances.

Models can represent a type of standalone device if they have no components.

Models with components specify a list of other models with their respective counts.

A project is a way to organize a collection of hardware devices belonging to a common model.Projects hold a collection of tests, which define the test suite to run against the devices in the project.

A project is a way to organize a collection of hardware devices belonging to a common model.

, which define the test suite to run against the devices in the project.

A test defines a single test case in a project's test suite.Tests hold measurements uploaded from hardware devices, which represent instances of the test being run.

A test defines a single test case in a project's test suite.

Tests hold measurements uploaded from hardware devices, which represent instances of the test being run.