Images API
Base path /v1/images. All requests require Authorization and X-SialFlow-Project-ID.
Delivery transforms use the data-plane /i/{org}/{image}/{transform}/… path (or pull ?sf=). Overlay assets (wi-) and bg-remove outputs are project-scoped. Build transform strings with workspace package @sialflow/url (not on the public npm registry yet).
| Method | Path | Description |
|---|---|---|
| GET | / | List image assets |
| GET | /{id} | Get image asset |
| POST | /uploads | Start image upload |
| POST | /{id}/pipelines | Studio pipeline (async; includes watermark) |
| POST | /{id}/pipelines/preview | Sync Studio preview (no persist) |
| POST | /{id}/bg-remove | Async background remove → new asset |
| GET | /jobs | List image jobs (filter by kind) |
| GET | /jobs/{id} | Poll job until complete; read output asset id |
| GET/PUT | /watermark-profile | Project default overlay |
| POST | /{id}/signed-urls | Signed delivery URL |
Example
# Background remove (async)
curl -X POST https://api.sialflow.com/v1/images/$IMAGE_ID/bg-remove \
-H "Authorization: Bearer $SIALFLOW_API_KEY" \
-H "X-SialFlow-Project-ID: $SIALFLOW_PROJECT_ID" \
-H "Content-Type: application/json" \
-d '{"format":"png"}'
# Sync CDN: e-bgremove + multi-layer ol (max 3) + g-auto
# /i/$ORG/$IMAGE_ID/w400-e-bgremove-f-png/preview.png
# /i/$ORG/$IMAGE_ID/w800-h600-fit-cover-g-auto-q80-f-jpeg/preview.jpg
# /i/$ORG/$IMAGE_ID/w800-wm-t-434f4e46-tp-br-ol-wm-t-5349414c-tp-tl-f-jpeg/preview.jpg
# TypeScript (workspace @sialflow/url)
# import { buildHostedPath, buildTransform } from "@sialflow/url"