Describe

Writes four example prompts based on an image you upload. This is the same as using the /describe command in Discord.

POST https://api.apiframe.pro/describe

Headers

NameValue

Content-Type

application/json

Authorization*

Your APIFRAME API Key

Body

NameTypeDescription

image_url*

string

The URL of the image you want to describe. Should be accessible on Internet.

webhook_url

string

The final result and updates of this task will be posted at this URL.

webhook_secret

string

Will be passed as x-webhook-secret in the webhook call headers for authentication.

Response

// Success, the task has been submitted
{
  "task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a"
}

This endpoint doesn't generate results instantly, you can use the Fetch endpoint to fetch the result or use webhooks.

The result (posted to the webhook_url or retrieved with the Fetch endpoint) looks like this:

{
    "task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
    "task_type": "describe",
    "image_url": "https://...............xx.png",
    "content": [
    "1️⃣ a red....",
    "2️⃣ a dog....",
    "3️⃣ a red dog....",
    "4️⃣ dog and ...."
    ]
}

If the job is not completed, you will get a result like this:

{
    "task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
    "task_type": "describe",
    "status": "processing",
    "percentage": "80"
}

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/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