Generate Metadata from Image File

POST

/api/v1/photo

This endpoint accepts an image as File and returns automatically generated metadata, including tags, color palettes, a title, and a description.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params multipart/form-data

image

file

required

config

string

optional

Stringify the PhotoConfig object

Example:

{ "tagConfig": { "allowOnlySingleWord": false, "hasTagCountLimits": true, "minTagCount": 1, "maxTagCount": 10 }, "metadataConfig": { "generateTitle": true, "maxTitleWords": 10, "generateColors": false, "generateDescription": true, "maxDescriptionWords": 10, "minDescriptionWords": 1 } }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/photo' \
--form 'image=@""' \
--form 'config="{
    \"tagConfig\": {
        \"allowOnlySingleWord\": false,
        \"hasTagCountLimits\": true,
        \"minTagCount\": 1,
        \"maxTagCount\": 10
    },
    \"metadataConfig\": {
        \"generateTitle\": true,
        \"maxTitleWords\": 10,
        \"generateColors\": false,
        \"generateDescription\": true,
        \"maxDescriptionWords\": 10,
        \"minDescriptionWords\": 1
    }
}"'

Responses

🟢200OK

application/json

Body

success

boolean

required

data

object

required

description

string

required