CoreViz
API

Image Description

POST /api/ai/describe — generate a description for an image

Image Description

Generate a detailed text description for an image.

SDK equivalent: sdk.describe() — see Vision SDK

Endpoint

POST /api/ai/describe

Request

curl -X POST https://lab.coreviz.io/api/ai/describe \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{ "image": "https://example.com/photo.jpg" }'

Request Body

FieldTypeRequiredDescription
imagestringYesImage URL or base64 data URI
promptstringNoCustom prompt to guide the description

Response

{ "description": "A red sports car parked on a cobblestone street..." }
FieldTypeDescription
descriptionstringGenerated description text