ROONIQ Cloud Compute API

Introduction

This is an async job execution API.

A job is submitted through a POST request, which returns a job object. The job object contains the following fields

id: A UUID string that can be used to query and manipulate the job.
status: One of pending, running, complete or failed.
result: Once the status is complete, this field is populated with the job result.

It is the API users responsibility to poll the API and check the job completion status.

The API requires authentication using a bearer token. Get you API key at https://iam.rooniq.com.

API Endpoints

Method

Location

Description

Parameters

POST (multipart/formdata)

/pipeline

Create a vision pipeline job

Key	Value
pipeline	Pipeline JSON file
frame	Frame JSON file
depth	Depth CSV file

GET

/pipeline/{id}

Get a vision pipeline job with id

DELETE

/pipeline/{id}

Delete a vision pipeline job with id.
If the job is running this operation will fail

An example request looks like this:

    
      curl -X POST \
           -H 'Authorization: Bearer $API_KEY' \
           https://api.rooniq.com/pipeline \
           -F pipeline=@pipeline.json \
           -F frame=@frame.json \
           -F depth=@frame.csv