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

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

resp = client.ask_image(
    image_url="https://example.com/image.jpg",
    question="What color is the car?"
)

print(resp.answer)
{
  "request_id": "<string>",
  "credits_used": 123,
  "answer": "<string>"
}

Authorizations

​
VISCRIBE-APIKEY
string
header
required

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

Body

application/json
​
question
string
required

The specific question to ask about the image.

​
image_url
string

URL of the image to analyze. 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.

Response

Successful response

​
request_id
string
required

Unique identifier for this request.

​
credits_used
integer
required

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

​
answer
string
required

The answer to the question based on the image content.