Skip to main content
POST
/
images
/
describe
Python SDK
from viscribe import Client

client = Client(api_key="your-api-key-here")

resp = client.describe_image(
    image_url="https://example.com/image.jpg",
    generate_tags=True
)

print(resp.image_description)
print(resp.tags)
{
  "request_id": "<string>",
  "credits_used": 123,
  "image_description": "<string>",
  "tags": [
    "<string>"
  ]
}

Authorizations

​
VISCRIBE-APIKEY
string
header
required

API key authentication. Include your API key in the VISCRIBE-APIKEY header.

Body

application/json
​
image_url
string

URL of the image to describe. Must be publicly accessible. Either image_url or image_base64 is required.

​
image_base64
string

Base64 encoded string of the image. Format: data:image/jpeg;base64,... or data:image/png;base64,.... Either image_url or image_base64 is required.

​
instruction
string

Optional instruction to guide the description (e.g., focus, style).

​
generate_tags
boolean
default:true

Whether to generate relevant tags for the image.

Response

Successful response

​
request_id
string
required

Unique identifier for this request.

​
credits_used
integer
required

The number of credits used (always 1 for describe).

​
image_description
string
required

Textual description of the image.

​
tags
string[]

List of relevant tags for the image, if generate_tags was true.