API 访问

开发环境

http://dev-cn.your-api-server.com

POST

/v1/describe

需要 API 密钥。您可以使用它们以编程方式访问 API。

不要与他人共享您的 API 密钥，或将其暴露在浏览器或其他客户端代码中。为了保护您帐户的安全，我们也可能会自动轮换我们已经拥有的任何 API 密钥成立已公开泄露。

使用 API 密钥，您可以以编程方式调用我们的 API。我们提供“/describe”端点以实现更快的批处理。根据您的订阅，它可以在 50 秒内批量描述最多 128 个图像。有关更多详细信息，请参阅下面的 API 文档。

Python 开发者：https://github.com/jina-ai/jinaai-py/

JavaScript 开发者：https://github.com/jina-ai/jinaai-js/

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/describe' \
--header 'x-api-key: token $YOUR_GENERATED_SECRET' \
--header 'content-type: application/json' \
--data-raw '{"data":[
  {"image": "https://picsum.photos/200", "features": []},
  {"image": "https://cdn.discordapp.com/attachments/1083723388712919182/1089909178266558554/HannaD_A_captivating_digital_artwork_features_a_red-haired_girl_664d73dc-b537-490e-b044-4fbf22733559.png", "features": []}
  ]}'

响应示例

{}

请求参数

Header 参数

x-api-key

string

必需

示例值:

token $YOUR_GENERATED_SECRET

content-type

string

必需

示例值:

application/json

Body 参数application/json

data

array [object {4}]

必需

待解释的批处理图像。数据应该是图像请求列表，每个请求都必须遵循以下结构。根据您的订阅，您最多可以在一个批次中指定 128 张图像。免费用户在一批中最多只能指定 8 张图片。详情可在计费页面中找到。

image

string

必需

指定要解释的图像文件。图像文件可以是 URL 或 base64 编码的字符串。支持的文件类型: png jpg webp gif svg

video

string

必需

请提供您要分析的视频的 URL。该参数对于“Inception”算法是必需的。请记住，视频大小不应超过 32MB。支持的文件类型: mp4

algorithm

string

必需

指定用于图像理解的模型。每种算法都有自己的优点和缺点。允许值: Jelly Bolt Hearth Inception Aqua Comet Dune Flash Glide GPT4V

features

array[string]

必需

为图像说明启用的附加功能。它可以是单个功能或多个功能。允许值: high_quality question_answer tts json opt_out 画外音支持的语言:

en de ja af sq am ar hy az eu bn bs bg ca hr cs da nl et fi fr gl ka el gu haw iw hi hu is id ga it jw kn kk km ko lo lv lt mk ms ml mt mr mn my ne no fa ps pl pt ro ru sr si sk sl so es su sw sv ta te th tr uk ur uz vi cy zu

示例

返回响应

🟢200成功

application/json

Body

object {0}

通过 ID 获取图像