Generate Metadata from Image URL

POST

/api/v1/photo

This endpoint accepts an image via URL 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 application/json

imageUrl

string

required

config

object (PhotoConfig)

optional

tagConfig

object (TagConfig)

optional

metadatConfig

object (MetadataConfig)

optional

Example

{
    "imageUrl": "https://tagphoto.b-cdn.net/46c66687-d54c-46b4-906c-d9e4f9e6ea7d.webp",
    "config": {
        "tagConfig": {
            "allowOnlySingleWord": false,
            "hasTagCountLimits": false,
            "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' \
--header 'Content-Type: application/json' \
--data-raw '{
    "imageUrl": "https://tagphoto.b-cdn.net/46c66687-d54c-46b4-906c-d9e4f9e6ea7d.webp",
    "config": {
        "tagConfig": {
            "allowOnlySingleWord": false,
            "hasTagCountLimits": false,
            "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