Skip to content

Download an image

v1.0.0
OpenAPI 3.1.0

Upriver API

A social insights API for ad generation platforms. It provides structured signals, like psychographics, behavioral insights, trends, and audience language, to help AI models generate relevant, higher-converting ads.

Server:https://api.upriver.ai

Production API server

Client Libraries

Download an image

​

Download an image from a public HTTPS URL. Useful when a website blocks direct image downloads.

Returns the original image bytes, with the format in Content-Type. Errors return JSON.

Supports JPEG, PNG, WebP, GIF, and AVIF up to 10 MiB, with at most 16 million pixels across up to 32 frames.

For product images, add image_url to include in POST /v1/brand/products and pass the returned URL here.

Body·ImageDownloadInput
required
application/json
  • url
    Type: string · Url
    min length:  
    1
    max length:  
    8192
    required

    Public HTTPS URL of the image to download.

Responses
  • 400

    Invalid or non-public URL.

  • 404

    Source image not found.

  • 413

    Request body or image exceeds a size, pixel, or frame limit.

  • application/json
  • 429

    Too many requests.

  • 502

    Source unavailable or did not return a supported image.

  • 503

    Image downloads temporarily unavailable. Retry later.

  • 504

    Download timed out.

Request Example for post/v1/images/download
curl https://api.upriver.ai/v1/images/download \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "url": "https://example.com/product.png"
}'
@filename