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

Once the job has finished, the result can be queried separately.

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) /job Create a generic vision job
Key Value
config Config file
frame Frame JSON file
depth Depth CSV file
GET /job/{id} Get a vision pipeline job with id
DELETE /job/{id} Delete a vision pipeline job with id.
If the job is running this operation will fail
GET /result/{jobid} Get the result from a completed job with id
POST (multipart/formdata) /measure-parcel Create a parcel measurement job.
After submission the job is handled as any other job
Key Value
frame Frame JSON file
depth Depth CSV file

Examples

Assuming you have acquired an API key through the IAM and (exported as ROONIQ_API_KEY), prepare the following variables: 
  
    export ROONIQ_API_KEY=<INSERT-API-KEY-HERE>
    export ROONIQ_API_URL=https://api.rooniq.com

Submit a job: 

    
      curl -X POST -H "Authorization: Bearer $ROONIQ_API_KEY" $ROONIQ_API_URL/job -F config=@config.json -F frame=@frame.json -F depth=@frame.csv

Query the job status: 

    
      curl -X GET -H "Authorization: Bearer $ROONIQ_API_KEY" $ROONIQ_API_URL/job/$JOB_ID

Once a job is completed, get the result: 

    
      curl -X GET -H "Authorization: Bearer $ROONIQ_API_KEY" $ROONIQ_API_URL/result/$JOB_ID

Retrieve your license: 

    
      curl -X GET -H "Authorization: Bearer $ROONIQ_API_KEY" $ROONIQ_API_URL/license