Getting Started

This guide walks through your first upload to Ecue using the current data source API.

What You Can Do Today

Upload one CSV/TSV file per archive
Track source processing status
Integrate upload flows into scripts and pipelines

Quick Upload Walkthrough

1) Prepare your file

Create a CSV or TSV file with a header row, for example sales.csv.

2) Build an archive

zip sales_upload.zip sales.csv

You can optionally include column_desc.json in the same archive.

3) Compute MD5 checksum

CHECKSUM=$(md5sum sales_upload.zip | awk '{print $1}')

4) Upload

curl -X POST "https://api.ecue.ai/api/v1/data-sources" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/zip" \
  -H "X-Checksum: ${CHECKSUM}" \
  --data-binary "@sales_upload.zip"

5) Poll status

curl -X GET "https://api.ecue.ai/api/v1/data-sources/YOUR_SOURCE_ID" \
  -H "Authorization: Bearer YOUR_TOKEN"

When status is ready, your source is available for downstream workflows.

Authentication

Data source API calls use bearer auth:

Authorization: Bearer YOUR_TOKEN

Accepted token types:

JWT access tokens
API keys used for importer callback uploads

Data and Archive Rules

Archive must be ZIP or TAR.GZ
Archive must contain exactly one .csv or .tsv
Nested directories are not allowed
Optional column_desc.json must be valid JSON object format
Archive size limit is 256MB