掘金 人工智能 08月11日
Flux Images Generation API 对接说明
index_new5.html
../../../zaker_core/zaker_tpl_static/wap/tpl_guoji1.html

 

本文详细介绍了Flux Images Generation API的对接流程,包括如何申请服务、基本使用方法、参数设置以及代码示例。API支持图片生成和编辑两种模式,用户可通过提供提示词、指定图片尺寸和模型等参数来定制化生成Flux官方图片。文章还阐述了异步回调机制,以解决API响应延迟问题,并提供了错误处理的常见情况及示例,帮助开发者高效集成和使用该API。

📝 **申请与获取使用权限**:要使用Flux Images Generation API,用户需先访问对应页面点击「Acquire」按钮申请服务。首次申请会赠送免费额度,登录或注册后即可使用。API调用需要设置`accept`为`application/json`及提供`authorization`密钥。

🖼️ **图片生成与编辑功能**:API支持两种主要操作:生成图片(action: generate)和编辑图片(action: edits)。生成图片需提供prompt、size、count等参数,而编辑图片则需传入image_url和model等参数。API会返回包含图片链接等信息的JSON数据。

🚀 **异步回调与任务关联**:考虑到图片生成可能耗时较长,API支持异步回调。用户可在请求时指定`callback_url`,API将在任务完成后将结果以POST JSON形式发送至该URL,并通过`task_id`字段实现任务结果的关联。

⚠️ **错误处理与响应机制**:API在调用过程中可能出现多种错误,如token_mismatched、invalid_token、too_many_requests等,并会返回相应的错误代码和信息。API响应包含`success`状态、`task_id`、`trace_id`以及`data`(包含图片URL等信息)等字段。

本文将介绍一种 Flux Images Generation API 对接说明,它是可以通过输入自定义参数来生成Flux官方的图片。

接下来介绍下 Flux Images Generation API 的对接说明。

申请流程

要使用 API,需要先到 Flux Images Generation API 对应页面申请对应的服务,进入页面之后,点击「Acquire」按钮,如图所示:

如果你尚未登录或注册,会自动跳转到登录页面邀请您来注册和登录,登录注册之后会自动返回当前页面。

在首次申请时会有免费额度赠送,可以免费使用该 API。

基本使用

首先先了解下基本的使用方式,就是输入提示词 prompt、 生成行为 action、图片尺寸 size,便可获得处理后的结果,首先需要简单地传递一个 action 字段,它的值为 generate,然后我们还需要输入提示词,具体的内容如下:

可以看到这里我们设置了 Request Headers,包括:

另外设置了 Request Body,包括:

选择之后,可以发现右侧也生成了对应代码,如图所示:

点击「Try」按钮即可进行测试,如上图所示,这里我们就得到了如下结果:

{  "success": true,  "task_id": "226eb763-9eab-4d06-ad57-d59753a03307",  "trace_id": "089f8b46-0167-4f25-88ee-3c3f88d80e84",  "data": [    {      "prompt": "a white siamese cat",      "image_url": "https://fal.media/files/lion/NVhtlwwGYQD6HrGaEfrzu_341484fad6d84b21b73f4f8824a3f98a.png",      "timings": 1752743801    },    {      "prompt": "a white siamese cat",      "image_url": "https://fal.media/files/monkey/8UEQpFbQCYVOK1wKP3aV0_9bbc26fad64049b18d0244b99ef66ad1.png",      "timings": 1752743801    }  ]}

返回结果一共有多个字段,介绍如下:

可以看到我们得到了满意的图片信息,我们只需要根据结果中 data 的图片链接地址获取生成的Flux图片即可。

另外如果想生成对应的对接代码,可以直接复制生成,例如 CURL 的代码如下:

curl -X POST 'https://api.acedata.cloud/flux/images' \-H 'authorization: Bearer {token}' \-H 'accept: application/json' \-H 'content-type: application/json' \-d '{  "action": "generate",  "prompt": "a white siamese cat",  "model": "flux-kontext-pro",  "count": 2}'

编辑图片任务

如果想对某张图片进行编辑的话, 首先参数image_url必须传入需要编辑的图片链接,此时 action 只支持 edits,就可以指定如下内容:

填写样例如下:

填写完毕之后自动生成了代码如下:

对应的代码:

import requestsurl = "https://api.acedata.cloud/flux/images"headers = {    "accept": "application/json",    "authorization": "Bearer {token}",    "content-type": "application/json"}payload = {    "action": "edits",    "prompt": "a white siamese cat",    "model": "flux-kontext-pro",    "image_url": "https://cdn.acedata.cloud/ytj2qy.png"}response = requests.post(url, json=payload, headers=headers)print(response.text)

点击运行,可以发现会立即得到一个结果,如下:

{  "success": true,  "task_id": "2a7979ff-1f77-4380-92c6-a2dc37c3b4c8",  "trace_id": "732b65c0-48d9-49f7-b568-64e5acffe4c0",  "data": [    {      "prompt": "a white siamese cat",      "image_url": "https://fal.media/files/monkey/aEUXJZ6Faj9YXUCQVs01Q_af0cea56c558441c9ba8df67b200812d.png",      "timings": 1752744073    }  ]}

可以看到,生成的效果是对原图片进行编辑的效果,结果与上文类似。

异步回调

由于 Flux Images Generation API 生成的时间相对较长,大约需要 1-2 分钟,如果 API 长时间无响应,HTTP 请求会一直保持连接,导致额外的系统资源消耗,所以本 API 也提供了异步回调的支持。

整体流程是:客户端发起请求的时候,额外指定一个 callback_url 字段,客户端发起 API 请求之后,API 会立马返回一个结果,包含一个 task_id 的字段信息,代表当前的任务 ID。当任务完成之后,生成图片的结果会通过 POST JSON 的形式发送到客户端指定的 callback_url,其中也包括了 task_id 字段,这样任务结果就可以通过 ID 关联起来了。

下面我们通过示例来了解下具体怎样操作。

首先,Webhook 回调是一个可以接收 HTTP 请求的服务,开发者应该替换为自己搭建的 HTTP 服务器的 URL。此处为了方便演示,使用一个公开的 Webhook 样例网站 webhook.site/,打开该网站即可得到一… Webhook URL,如图所示:

将此 URL 复制下来,就可以作为 Webhook 来使用,此处的样例为 https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab

接下来,我们可以设置字段 callback_url 为上述 Webhook URL,同时填入相应的参数,具体的内容如图所示:

点击运行,可以发现会立即得到一个结果,如下:

{  "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c"}

稍等片刻,我们可以在 https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab 上观察到生成图片的结果,如图所示:

内容如下:

{    "success": true,    "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c",    "trace_id": "9b4b1ff3-90f2-470f-b082-1061ec2948cc",    "data": [        {            "prompt": "a white siamese cat",            "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/f4f8d407-377a-408a-82d0-427a5a836f09_0.png",            "seed": 1698551532,            "timings": {                "inference": 3.328            }        }    ]}

可以看到结果中有一个 task_id 字段,其他的字段都和上文类似,通过该字段即可实现任务的关联。

错误处理

在调用 API 时,如果遇到错误,API 会返回相应的错误代码和信息。例如:

错误响应示例

{  "success": false,  "error": {    "code": "api_error",    "message": "fetch failed"  },  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"}

结论

通过本文档,您已经了解了如何使用 Flux Images Generation API 可通过输入提示词来生成图片。希望本文档能帮助您更好地对接和使用该 API。如有任何问题,请随时联系我们的技术支持团队。

Fish AI Reader

Fish AI Reader

AI辅助创作,多种专业模板,深度分析,高质量内容生成。从观点提取到深度思考,FishAI为您提供全方位的创作支持。新版本引入自定义参数,让您的创作更加个性化和精准。

FishAI

FishAI

鱼阅,AI 时代的下一个智能信息助手,助你摆脱信息焦虑

联系邮箱 441953276@qq.com

相关标签

Flux Images Generation API 图片生成 API对接 异步回调
相关文章