API & SDK

Marple DB functions best when it is tightly integrated into your workflow. Our API can be used to automate data uploads from Onedrive, S3, test rigs, vehicles, ...

API tokens

Using the API and SDK requires API tokens. Generate a token in the settings:

HTTP API

Making requests

All API calls should be made against the base URL

• For SaaS: db.marpledata.com/api/v1

• VPC and self-managed: {dbhost}/api/v1

The API token should be included in the Authorization header as a Bearer token.

Adding and importing files

Uploading files to a datastream can be done using these three endpoints:

POST {base_url}/stream/{stream_id}/ingest

• stream_id e.g. 2, can be seen in the URL on the stream page

• formData should contain

  • file the file to upload and import

  • dataset_name the filename

• Returns: a dataset_id

GET stream/{stream_id}/datasets/status

• stream_id

• Returns: import status and progress (%) per dataset_id

GET stream/{stream_id}/dataset/{dataset_id}

• stream_id

• dataset_id

• Returns: more detailed info about the file

API Reference

Swagger and Redoc documentation of our API is published at https://<yourmarpledb>/api/docs and /api/redoc.

For our Marple DB SaaS, they can be found at https://db.marpledata.com/api/docs.

SDK

Python and MATLAB wrappers for our API are in beta testing.