Reference Guide
REST API Reference
Downloads
Request download URLs for outputs.
| Operation | HTTP Request |
|---|---|
| Get Download URLs | GET /outputs-availability |
Outputs
Request and manage outputs.
| Operation | HTTP Request |
|---|---|
| Check Outputs Availability | GET /outputs-availability |
| Create Outputs | POST /outputs |
| Delete Output | DELETE /outputs/{outputId} |
| Get Output | GET /outputs/{outputId} |
| Get Outputs Request | GET /outputs-request/{outputsRequestId} |
| List Outputs | GET /outputs |
Products
Manage products and their data sets.
| Operation | HTTP Request |
|---|---|
| Create Product | POST /products |
| Delete Product | DELETE /products/{productId} |
| Delete Upload | DELETE /products/{productId}/upload |
| Get Product | GET /products/{productId} |
| Get Signed Download URL | GET /products/{productId}/download-url |
| Get Upload URLs | POST /products/{productId}/upload-urls |
| List Products | GET /products |
| Mark Upload Complete | POST /products/{productId}/complete-upload |
| Update Product | PATCH /products/{productId} |
Releases
Manage releases.
| Operation | HTTP Request |
|---|---|
| Create Release | POST /releases |
| Delete Release | DELETE /releases/{releaseId} |
| Get Release | GET /releases/{releaseId} |
| List Releases | GET /releases |
| Update Release | PATCH /releases/{releaseId} |
Rules
Request rules evaluation for inputs.
| Operation | HTTP Request |
|---|---|
| Evaluate Rules | POST /rules:evaluate |
| Get Rules | GET /rules/{rulesKey} |
| Validate Rules | POST /rules:validate |
Uploads
Request and manage uploads for outputs.
| Operation | HTTP Request |
|---|---|
| Get Upload Request | GET /uploads/{uploadRequestId} |
| List Upload Requests | GET /uploads |
| Create Upload Request | POST /uploads |
Variants
Manage variants.
| Operation | HTTP Request |
|---|---|
| Create Variant | POST /variants |
| Delete Variant | DELETE /variants/{variantId} |
| Get Variant | GET /variants/{variantId} |
| List Variants | GET /variants |