Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.viscribe.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Provide Feedback

We value your feedback to help improve ViscribeAI’s image analysis capabilities. There are two ways to provide feedback:

​
Option 1: Dashboard Feedback Button

The easiest way to provide feedback is through the dashboard:
  1. Go to dashboard.viscribe.ai
  2. Click the “Provide Feedback” button in the bottom right corner
  3. Fill out the feedback form with your rating and comments
This method is perfect for quick feedback on API responses you’ve received.

​
Option 2: Feedback API Endpoint

You can also provide feedback programmatically using the Feedback API endpoint or SDK:

​
Using the Python SDK

from viscribe import Client

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

# First, make an API call to get a request_id
response = client.describe_image(
    image_url="https://example.com/image.jpg"
)

# Then submit feedback for that request
feedback_response = client.submit_feedback(
    request_id=response.request_id,
    rating=5,  # Rating from 0-5
    feedback_text="Perfect image description!",
)

print(f"Feedback ID: {feedback_response.feedback_id}")

​
Using the API Directly

curl -X POST https://api.viscribe.ai/v1/feedback \
  -H "VISCRIBE-APIKEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "your-request-id",
    "rating": 5,
    "feedback_text": "Great response!"
  }'

​
Feedback Details

  • Rating: A number from 0-5 indicating the quality of the response
  • Feedback Text: Optional text describing your feedback
  • Request ID: The ID from a previous API call that you want to provide feedback on

​
Why Provide Feedback?

Your feedback helps us:
  • Improve the accuracy of our AI models
  • Better understand edge cases and errors
  • Enhance the overall quality of the API
  • Prioritize feature development
Thank you for helping us improve ViscribeAI!