Annotations

Image annotations - Get caption

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/getCaption/v2
AuthorizationBearer <token>

In: header

file?string
url?string
question?string
options?string

Response Body

Examples

curl -X POST "https://api.piktid.com/api/getCaption/v2"
{
  "image_id": "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"
}