图像描述生成器 API 文档 (V2)

简介与使用场景

图像描述生成器 API 允许您将 AI 驱动的图像描述功能集成到您的应用程序中。我们的 API 使用先进的 AI 模型来分析图像并生成详细的描述。

常见使用场景

生成图像的详细描述
从图像中提取文本和信息
分析图像内容和上下文
为创意写作创建角色描述
为内容管理生成图像说明

API 密钥

要使用我们的 API，您需要获取 API 凭证（API 密钥和密钥）。您可以在仪表板中管理您的 API 密钥。

API 接口地址

POST https://imagedescriber.online/api/openapi-v2/describe-image

集成指南

请求头

头部名称	必需	描述
content-type	是	必须为 multipart/form-data
authorization	是	必须为 Bearer ${SECRET_KEY} ${SECRET_KEY} 是您的 API 密钥。

请求参数

参数	类型	必需	描述
image	string 或 file	是	需要生成描述的图像。支持三种输入格式： 1. 图像 URL，以 http:// 或 https:// 开头。 2. Base64 编码图像，格式为：data:image/jpeg;base64,/9j/4AAQSkZJR...（注意：其他图像类型如 PNG 也可以，请相应调整 mime-type） 3. 文件对象：表示模型图像的文件对象。
prompt	string	是	图像分析的自定义提示词
lang	string	否	响应语言 (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru)，默认：en

响应格式

字段	类型	描述
code	number	响应状态码。200 表示成功
data	object	响应数据对象，当 code 为 200 时存在
data.content	string	为图像生成的描述
msg	string	响应消息，提供额外信息
succeed	boolean	表示请求是否成功

响应示例

{
    "code": 200,
    "data": {
        "content": "以 markdown 格式的详细图像描述..."
    },
    "succeed": true,
    "msg": "成功"
}

错误代码

代码	消息	描述
200	OK	请求成功
500	SERVER_ERROR	服务器内部错误
10003	INSUFFICIENT_CREDITS	积分不足
10004	INVALID_PARAM	无效参数
10005	HARMFUL_CONTENT	检测到有害内容
30001	INVALID_API_KEY	无效的 API 密钥
30002	INVALID_SIGNATURE	无效的请求签名

代码示例

使用图像 URL 的 Curl 示例

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="https://persistent.imagedescriber.online/image-describer-examples/000.jpg"' \
--form 'prompt="简要描述图像的内容"' \
--form 'lang="zh"'

使用本地图像文件的 Curl 示例

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image=@"/PATH/TO/YOUR/IMAGE.jpg"' \
--form 'prompt="简要描述图像的内容"' \
--form 'lang="zh"'

使用图像 Base64 的 Curl 示例

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="data:image/jpeg;base64,/9j……/9k="' \
--form 'prompt="简要描述图像的内容"' \
--form 'lang="zh"'

Node.js 示例

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // 替换为您的实际 API 密钥

  const formData = new FormData();
  formData.append('image', ...); // 支持 url、图像文件、图像 base64 编码
  formData.append('prompt', '简要描述图像的内容');
  formData.append('lang', 'zh'); // 响应语言代码

  const apiEndpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image';
  try {
    const response = await fetch(apiEndpoint, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
      },
      body: formData,
    });

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`HTTP error ${response.status}: ${errorData.msg || '未知错误'}`);
    }

    const data = await response.json();
    return { content: data.data.content, error: null };

  } catch (error) {
    console.error('描述图像时出错:', error);
    return { content: null, error: error.message };
  }
}

Python 示例

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # 替换为您的实际 API 密钥

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # 示例 base64 图像。替换为您的实际图像数据。支持 url、文件和 base64。
        'prompt': '简要描述图像的内容',
        'lang': 'zh' # 响应语言代码
    }

    api_endpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image'
    try:
        headers = {
            'Authorization': f'Bearer {api_key}',
        }

        response = requests.post(api_endpoint, files=form_data, headers=headers) # 使用 files= 进行 multipart/form-data 请求
        response.raise_for_status()  # 对错误状态码（4xx 或 5xx）抛出异常

        data = response.json()
        return {'content': data.get('data', {}).get('content'), 'error': None}

    except requests.exceptions.RequestException as e:
        print(f'描述图像时出错: {e}')
        return {'content': None, 'error': str(e)}

定价

API 调用会消耗您账户中的积分。您可以在我们的定价页面购买积分。

查看定价 →

帮助与支持

如果您有任何问题或需要帮助，请随时联系我们的支持团队。

邮箱：[email protected]