API 访问

开发环境

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

POST

/v1/generate

需要 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/generate' \
--header 'x-api-key: token $YOUR_GENERATED_SECRET' \
--header 'content-type: application/json' \
--data-raw '{
    "data":[
      {"text": "In todays fast-paced environment, increasing productivity ..."},
      {"text": "When you have two days to finish a task ..."}
    ]
  }'

响应示例

{}

请求参数

Header 参数

x-api-key

string

必需

示例值:

token $YOUR_GENERATED_SECRET

content-type

string

必需

示例值:

application/json

Body 参数application/json

data

array [object {3}]

必需

数据应该是请求列表，每个请求都遵循以下结构。

text

string

必需

指定用于生成横幅的文本。

style

string

可选

生成横幅的风格 - “摄影”风格将生成看起来像照片的横幅，“极简”风格将生成构图简单的横幅，“平面”风格将生成看起来像现代插图的现代横幅，而“default”样式将生成没有特定样式的各种横幅。允许值: default photographic minimalist flat

callback_url

string

可选

指定将在进程结束时调用的 URL。这是一个 POST 请求，结果将附加在正文中。

示例

返回响应

🟢200成功

application/json

Body

object {0}