AI Image Description API
Describe image content using AI technology
The AI Image Description API allows you to use advanced AI technology to describe image content. This endpoint processes images and returns detailed text descriptions. Experience the powerful AI image description feature of AI Describe Picture.
Endpoint
Authentication
Requires a valid API key in the Authorization header:
Request
Headers
Header | Required | Description |
---|---|---|
Content-Type | Yes | Must be application/json |
Authorization | Yes | Your API key in format Bearer YOUR_API_KEY |
Body Parameters
Parameter | Type | Required | Description |
---|---|---|---|
imageUrl | string | Yes | URL of the image to describe (must be publicly accessible) |
prompt | string | No | Custom prompt (optional) |
Request Example
Response
Success Response (200)
API returns a JSON object containing image descriptions with a choices array.
Description:
choices
array contains AI-generated description content, each choice contains a complete message objectmessage.content
field contains the actual image description text- Response format is compatible with OpenAI API
Error Responses
400 Bad Request
401 Unauthorized
402 Payment Required
500 Internal Server Error
Usage Limits
- Credit consumption: 1 credit per description
- Image requirements: Supports JPG, PNG, WebP formats, maximum 5MB
Usage Examples
JavaScript/Node.js
cURL
Image Requirements
- Format: JPG, PNG, WebP
- Size: Maximum 5MB
- Accessibility: Image URL must be publicly accessible
- Content: Must be a valid image file
Processing Time
- Typical: 10-30 seconds
- Large images: May take up to 60 seconds
Credits
- Cost: 1 credit per description
- Deduction: Credits are deducted upon successful processing
Best Practices
- Image quality: Use high-quality images for better results
- Error handling: Always implement proper error handling
- Credit management: Monitor your credit balance regularly
- Prompts: Use specific prompts for more precise descriptions
Troubleshooting
Common Issues
401 Unauthorized
- Check that your API key is correct
- Ensure the API key is active and not expired
402 Payment Required
- Add credits to your account
- Check your current credit balance
400 Bad Request
- Verify the imageUrl is a valid, accessible URL
- Ensure the image format is supported
500 Internal Server Error
- Server internal error, please try again later
- Check if the image URL is accessible
Support
If you encounter issues not covered here, please contact our support team.