Describe
Extensively describe the provided image.
POST
https://api.apiframe.pro/describe
Headers
Name
Value
Content-Type
application/json
Authorization*
Your APIFRAME API Key
Body
Name
Type
Description
image_url
*
string
The URL of the image you want to describe. Should be accessible on Internet.
Response
// Success, the task has been submitted
{
"task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
"status": "finished",
"task_type": "ideogram-describe",
"description": "A vibrant blue bird perched on a thin wire. The bird has a sharp beak, a round eye, and its feathers exhibit a gradient of blue hues. The background is blurred, emphasizing the bird, and appears to be an outdoor setting with a neutral color palette."
}
Code samples
const axios = require('axios');
let data = JSON.stringify({
"image_url": "https://...............xx.png"
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.apiframe.pro/ideogram-describe',
headers: {
'Content-Type': 'application/json',
'Authorization': 'YOUR_API_KEY'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Last updated
Was this helpful?