Describe

POST https://www.kkiai.com/ideogram/describe

Official documentation: https://developer.ideogram.ai/api-reference/api-reference/describe

Request Parameters

Header Parameters

Parameter	Type	Required	Description	Example
Content-Type	string	Required		application/json
Accept	string	Required		application/json
Authorization	string	Required		Bearer {{YOUR_API_KEY}}

Body Parameters (multipart/form-data)

Parameter	Type	Required	Description
image_file	file	Optional	(Required) Source image file

cURL Example

curl --location --request POST 'https://www.kkiai.com/ideogram/describe' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--form 'image_file=@"C:\\Users\\Administrator\\Desktop\\Example.png"'

Response

🟢 200 Success

Response Body

Parameter	Type	Required	Description
code	integer	Required
message	string	Required
request_id	string	Required
data	object	Required
└ task_id	string	Required
└ task_status	string	Required
└ created_at	integer	Required
└ updated_at	integer	Required

Response Example

{
    "code": 0,
    "message": "SUCCEED",
    "request_id": "CjMT7WdSwWcAAAAAALvB3g",
    "data": {
        "task_id": "CjMT7WdSwWcAAAAAALvB3g",
        "task_status": "submitted",
        "created_at": 1733851336696,
        "updated_at": 1733851336696
    }
}