Image

Use the image endpoints to retrieve images stored against Media

Unlike other API endpoints, images may only be retrieved via the cdn.orb360.tech domain

Get an Image (from Media)

get

Retreive an image using it's path and signing parameter, specifying a particular image size, quality and format.

Path parameters

imgPathstringrequired

Path to the stored image in the DAM

Example: 7e5092af-f35b-4e61-9a90-953d06eaa056/shoots/8ee5480a-bc94-4f56-b354-ce71ad0a6458/89b05784-9dd3-4aba-8769-04fd2370246e/img10.jpg

Query parameters

fmtstring · default: "jpeg"optional

The image format (jpeg, webp or png) to convert to and return

Example: png

wnumberrequired

The image width (px) to resize the image to, height is scaled based on the image aspect ratio automatically

Example: 1024

qnumber · default: 90optional

The image quality to use when resampling the image 100=best,longest 1=worst,quickest

Example: 94

sstringrequired

The signing secret provided by the server for this request. All request parameters must be provided by the server.

Example: 498c6036059d94be00931750369ef1fb3c33b965113c4560880e352be097337d

Responses

image/jpegimage/pngimage/webp

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orb360.tech/image/{imgPath}?w=1024&s=498c6036059d94be00931750369ef1fb3c33b965113c4560880e352be097337d'

200

400

404

200

image/jpeg

image/png

image/webp

image/jpeg

No body

success