Skip to main content
POST
TypeScript

Authorizations

x-ty-api-key
string
header
required

API key for TopYappers API authentication

Body

application/json

Image processing request. Send either image_url for a single image or images for a batch of up to 20 images.

image_url
string<uri>
required

Publicly accessible URL to a single image file

Example:

"https://example.com/image.jpg"

images
object[]

Batch of image URLs and optional image-specific parameters

Required array length: 1 - 20 elements
parameters
object

Optional image processing parameters. Global parameters apply to every image unless an image includes its own value.

Example:

Response

Images processed successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Images processed successfully"

data
object
required