Skip to main content
POST
/
api
/
ai
/
tools
Run an AI media analysis tool
curl --request POST \
  --url https://convertly.sh/api/ai/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "result": {
    "summary": "<string>",
    "tags": [
      "<string>"
    ],
    "categories": [
      "<string>"
    ],
    "altText": "<string>",
    "safety": {
      "safe": true,
      "labels": [
        "<string>"
      ],
      "reason": "<string>"
    },
    "confidence": 123
  },
  "usage": {
    "units": 123,
    "operation": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Body

multipart/form-data

Provide either file or sourceUrl with an AI analysis operation.

​
operation
enum<string>
required

AI analysis operation to run.

Available options:
image.describe,
image.alt-text,
image.tags,
image.moderate
​
file
file

Image upload input. Required unless sourceUrl is provided.

​
prompt
string

Optional context for the AI operation.

Maximum string length: 2000
​
sourceUrl
string<uri>

Remote HTTP(S) file input. Use instead of file for single-file tools.

​
async
enum<string>
default:false

Set true to queue the media tool as a background job.

Available options:
true,
false
​
background
enum<string>

Alias for async=true.

Available options:
true,
false

Response

AI tool result and usage

​
result
object
required
​
usage
object
required