img2.sitedocs
Flow guides

Three flows: upload, delivery, and usage.

Each guide describes one flow over the REST API, what your app sends, what comes back and when to wait. With JavaScript, the SDKs handle the upload flow for you.

1. Upload

  1. Your server creates an upload session with the file's type and size.
  2. The bytes go to storage: one PUT or S3 multipart parts straight to the bucket, or through the API's upload proxy.
  3. Complete the session (or let img2site notice the object) and wait for ready.
Read the upload-flow guide

2. Delivery

  1. A ready file is served on your project's delivery host.
  2. A transform chain in the path picks the size, crop, format, quality and watermark.
  3. Protected projects serve only signed URLs minted by your server.
Read the delivery-URLs guide

3. Usage and billing

  1. Each successful delivery is metered by bytes served.
  2. Closed hours are rolled up hourly; credits are charged once a day.
  3. Delivery stops with 403 quota_exceeded when the credit balance is used up.
Read the usage-and-billing guide

Webhooks

Signed notifications for ready uploads, moderation and quota changes.

Read about webhooks

REST reference

Every operation with its parameters, scopes and responses.

Open the reference