Skip to main content

​
Get started in three steps

Get up and running with ViscribeAI’s image analysis API in just a few minutes.

​
Step 1: Get your API key

  1. Sign up at dashboard.viscribe.ai
  2. Verify your email address
  3. Navigate to the API Keys section in your dashboard
  4. Copy your API key (starts with vsc_)
New accounts get 25 free image requests to test the API!
Your API key is sensitive. Never commit it to version control or share it publicly.
  • Store it in environment variables
  • Use a secrets manager for production
  • Rotate keys if compromised

​
Step 2: Make your first API call

Replace YOUR_API_KEY with your actual API key:
# Using image URL
curl -X POST https://api.viscribe.ai/v1/images/describe \
  -H "VISCRIBE-APIKEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://images.unsplash.com/photo-1521572163474-6864f9cf17ab",
    "instruction": "Describe this product image for an e-commerce listing",
    "generate_tags": true
  }'

# Or using base64 encoded image
curl -X POST https://api.viscribe.ai/v1/images/describe \
  -H "VISCRIBE-APIKEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_base64": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    "instruction": "Describe this product image for an e-commerce listing",
    "generate_tags": true
  }'
You should receive a response with the image description and tags.
Install the Python SDK:
pip install viscribe
Then use it in your code:
from viscribe import Client

client = Client(api_key="YOUR_API_KEY")

# Using image URL
response = client.describe_image(
    image_url="https://images.unsplash.com/photo-1521572163474-6864f9cf17ab",
    instruction="Describe this product image for an e-commerce listing",
    generate_tags=True
)

# Or using base64 encoded image
# response = client.describe_image(
#     image_base64="data:image/jpeg;base64,/9j/4AAQSkZJRg...",
#     instruction="Describe this product image for an e-commerce listing",
#     generate_tags=True
# )

print(response.image_description)
print(response.tags)

​
Step 3: Explore the endpoints

ViscribeAI offers five powerful endpoints:
  • Describe: Generate image descriptions and tags
  • Extract: Extract structured data from images
  • Classify: Categorize images into classes
  • Ask: Ask questions about image content
  • Compare: Compare two images side-by-side
Check out the API Reference for detailed documentation on each endpoint.

​
Authentication

All API requests require authentication using the VISCRIBE-APIKEY header: 
VISCRIBE-APIKEY: YOUR_API_KEY

​
Base URL

All API requests should be made to: 
https://api.viscribe.ai/v1

​
Rate Limits

Rate limits vary by subscription plan:
  • Free Trial: 5 requests per minute
  • Starter: 10 requests per minute
  • Growth: 30 requests per minute
  • Pro: 100 requests per minute

​
Next steps

API Reference

Explore all available endpoints and their parameters.

Dashboard

View your usage, manage API keys, and upgrade your plan.
Need help? Contact us at [email protected] or check out our GitHub repository.