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

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

resp = client.compare_images(
    image1_url="https://example.com/image1.jpg",
    image2_url="https://example.com/image2.jpg"
)

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

Authorizations

​
VISCRIBE-APIKEY
string
header
required

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

Body

application/json
​
image1_url
string

URL of the first image. Must be publicly accessible. Either image1_url or image1_base64 is required.

​
image1_base64
string

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

​
image2_url
string

URL of the second image. Must be publicly accessible. Either image2_url or image2_base64 is required.

​
image2_base64
string

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

​
instruction
string
default:Describe the similarities and differences between these two images.

Instruction for the comparison task.

Response

Successful response

​
request_id
string
required

Unique identifier for this request.

​
credits_used
integer
required

The number of credits used (always 2 for compare).

​
comparison_result
string
required

Textual comparison result describing similarities and differences between the two images.