Getimagedescription

Image annotations - Get image description

Deprecation notice

This endpoint is deprecated. We recommend using alternative endpoints to ensure continued support and compatibility.

This endpoint receives an image in base64 format and returns a description of the image in the following format:

  • Long description of the image: ['long_description']
  • Short description of the image: ['short_description']
  • Objects present in the image: ['objects_present']
  • List of main colors visible in the image: ['colors']
  • Mood of the image: ['mood']

The response is in a JSON dictionary format as shown below:

{
"data": {
"long_description": "...",
"short_description": "...",
"objects_present": "...",
"colors": "...",
"mood": "..."
}
}
POST
/api/getImageDescription

Authorization

token_auth_2
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

base64*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.piktid.com/api/getImageDescription" \  -H "Content-Type: application/json" \  -d '{    "base64": "string"  }'
{
  "data": {
    "long_description": "string",
    "short_description": "string",
    "objects_present": "string",
    "colors": "string",
    "mood": "string"
  }
}
{
  "code": 0,
  "message": "string",
  "description": "string"
}
{
  "code": 0,
  "message": "string",
  "description": "string"
}
{
  "code": 0,
  "message": "string",
  "description": "string"
}