API Reference
The current public API scope documented here is data source upload and status retrieval.
Base URL
All API requests should be made to:
https://api.ecue.ai/api/v1
Authentication
Data source endpoints require bearer authentication. The API accepts:
- JWT access tokens
- API keys valid for importer callback uploads
Include your token in the Authorization header:
Authorization: Bearer YOUR_TOKEN
Available Endpoints
Data Sources
- Data Upload
POST /api/v1/data-sources- Upload a ZIP or TAR.GZ archive containing exactly one CSV/TSV fileGET /api/v1/data-sources/{source_id}- Get import statusPUT /api/v1/data-sources/{source_id}- Currently returns501 not_implemented
Rate Limiting
No explicit per-endpoint rate limit is documented at this time.
Practical request limits for uploads:
- Global request body limit middleware: 2GB
- Data source archive extraction limit: 256MB (enforced for uploaded archive content)
Error Responses
Data source handlers return a flat error object:
{
"error": "invalid_request",
"message": "..."
}
Common examples include:
missing_checksuminvalid_requestno_data_filemultiple_data_filesnested_directoriesinvalid_column_descinvalid_archivesource_not_foundnot_implemented