Skip to main content
POST
/
feedback
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}")
{
  "feedback_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "Feedback submitted successfully",
  "feedback_timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
VISCRIBE-APIKEY
string
header
required

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

Body

application/json
​
request_id
string<uuid>
required

The unique identifier (UUID) of the API request you're providing feedback for.

​
rating
integer
required

Rating from 0 to 5, where 0-1: Poor quality, 2-3: Acceptable, 4-5: High quality.

Required range: 0 <= x <= 5
​
feedback_text
string

Optional text feedback providing additional context about the rating.

Response

Successful response

​
feedback_id
string<uuid>
required

Unique identifier for the submitted feedback.

​
request_id
string<uuid>
required

The request ID this feedback is associated with.

​
message
string
default:Feedback submitted successfully
required

Confirmation message.

​
feedback_timestamp
string<date-time>
required

ISO 8601 timestamp of when the feedback was submitted.