Start an optimization

Starts an optimization job, of an image or a video, and answers at once with its id. Poll GET /optimize/{id} or pass callback_url for a signed webhook.

POSThttps://realpng.com/api/v1/optimize

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Exactly one image, video or audio source. Pass seconds for video or audio if you know its length.

image_url?string

Public http or https URL on the default port, up to 25 MB

Formaturi

image_base64?string

Base64, or a data URL, up to 4 MB

image_upload_id?string

The id from POST /uploads, for a file already PUT to its upload_url

Formatuuid

video_url?string

Public http or https URL on the default port of an MP4, MOV or WebM up to 1 GB. Use POST /uploads for a large video.

Formaturi

video_upload_id?string

The id from POST /uploads, for a video already PUT to its upload_url

Formatuuid

audio_url?string

Public MP3, WAV or M4A URL up to 1 GB.

Formaturi

audio_upload_id?string

The id from POST /uploads, for a voice clip already PUT to upload_url

Formatuuid

seconds?number

A video's or voice clip's length in seconds. Credits are held for it and a longer file is refused. Without it, credits for 3 minutes are held, and the real length is charged once the job finishes.

Range0 < value <= 180

callback_url?string

Public https URL on the default port. The finished optimization is POSTed to it, the same body GET /optimize/{id} answers, signed in the RealPNG-Signature header as sha256=HMAC-SHA256(body, signing secret) with the signing secret of the key that started it.

Formaturi

Response Body

`application/json`

curl -X POST "https://realpng.com/api/v1/optimize" \  -H "X-API-Key: $REALPNG_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "image_url": "https://images.example.com/portrait.jpg"  }'

{  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",  "status": "queued",  "media": "image"}

Start an optimization

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

202application/json

400application/json

401application/json

402application/json

404application/json

413application/json

415application/json

429application/json

503application/json

defaultapplication/json