API

This document describes the supported REST API endpoints

All REST API endpoint are accessible via your environment subdomain endpoint, e.g: https://acme.cedalio.dev/api/v1

Authentication

Authentication is done via Basic Auth

Error response

All errors are return with the following format:

{
  "errors": [
    {
      "code": "resource_validation_error",
      "message": "The resource could not be modified because is not valid",
      "context": [
        {
          "field": "processable_data_type",
          "errors": [
            "can't be blank"
          ]
        }
      ]
    }
  ]
}

Where each error object has the following fields:

  • code A string representing a human readable error code

  • message A string containing the error message

  • context An optional object or array whose content depends on the type of error being returned that adds more contextual information about the error

Resources

Files batches

Create a files batch

Example cURL

Example response

Fetch a files batch

Example cURL

Example response

Update a batch

Example cURL

Example response

Fetch all files batches

Example cURL

Example response

Files

Upload file to batch

Example cURL

Example response

Fetch all batch files

Example cURL

Example response

Fetch a file

Example cURL

Example response

Delete a file

Example cURL

Example response

Processed data

Fetch all processed data for files batch

Example cURL

Example response

Fetch processed data

Example cURL

Example response

Update processed data

Example cURL

Example response

Review processed data

Example cURL

Example response

Untitled
PreviousSolution blueprintNextData security

Last updated