Stable Diffusion 是一个深度学习模型,通常用于图像合成和修改任务,是一个基于文本的图像生成模型,可以根据用户提供的文本描述生成图像。
要理解 Stable Diffusion API 文档,首先需要明白几个关键概念:
- API: 一个接口,允许不同的软件应用程序以编程的方式进行交互。在这种情况下,Stable Diffusion API 将允许开发者通过编程方式访问模型的图像合成功能。
- Endpoint: API 的端点是 URL 的特定位置,你可以通过向这些 URL 发送请求来与 API 交互。例如,
/generate-image
可能是一个 API 端点,用于生成图像。 - Request: 这是你通过 API 发送的一个调用命令,通常包含了需要 API 进行操作的数据。在 Stable Diffusion API 中,一个请求可能包含文本描述,样式参数,以及生成图像的任何其他相关选项。
- Response: 这是 API 在处理了你的请求之后返回的数据。对于 Stable Diffusion API,响应可能是一个生成的图像或是关于操作成功与否的相关信息。
Stable Diffusion API 文档的在线地址为 https://stablediffusionapi.apifox.cn/,点击即可访问。项目中包含了 Stable Diffusion 官方提供的所有 API,你可以根据需要进行操作,里面会简要介绍某个功能模块怎么使用。这个在线地址的项目你可以克隆到 Apifox,以方便调试。
Stable Diffusion API 文档中包含了文本到图像、图像到图像、修复 API、排队图像、系统负载、Lora 模型、Dreambooth 模型 (V2)、训练状态、模型列表、训练相关、文字转视频、管理信息系统、ControlNet、图像编辑API、文本转 3D 等 API 文档信息。
下面来图文讲解一下 Stable Diffusion API 的具体使用,前提是你打开了 Apifox。
Stable Diffusion API 文档使用说明
一、获取密钥(API_KEY)
所有 API 请求均由密钥授权,你可以通过注册获得一份,注册地址为https://stablediffusionapi.com/register
,你可以通过 Google 账号登录进去(需要科学上网)。
登录进去后,找到“API Settings”,点击它,然后在右侧点击“View API Key”,你将会看到一个 API Key,复制下来即可。
二、在 Apifox 中配置 API_KEY
然后我们打开 Apifox,进入到 “Stable Diffusion API”项目的环境管理里面,将刚才复制的 API Key 粘贴到本地值那里,这个 API Key 只保存在本地,其它任何人都无法看到,包括团队成员,也不会同步到 Apifox 的服务器上,所以不用担心安全问题。粘贴进去后,保存即可。
三、发起请求
接着在接口文档中选择一个接口发起请求,这里选中“文本到图像”接口,然后依次点击“运行->Body->json”,你会看到下面一大堆的请求参数里面有一个属性名为“key”的参数,你可以将刚才复制的 API_Key 直接粘贴到这里,然后直接发送请求。
也可以通过“动态值” ,读取刚才配置在环境变量中的api-key
。选择api-key
,然后点击“插入”即可。
插入完毕,你可以看到“key”属性的后面多了一个变量{{api-key}}
。现在我们可以开始绘图了,我们点击“发送”按钮,然后你会看到返回了一大串 JSON 对象。
找到“output”属性,“Ctrl + 鼠标左键”点击它的链接,你会看到在浏览器中打开了刚刚绘制的图像。如果你想生成其它图像,你也可以在 Apifox 中修改接口中的请求参数值。
你要调试其它 Stable Diffusion 接口也是一样的道理,把 API Key 粘贴进去,然后发送请求就行了。当然接口很多的话还是推荐使用“动态值”的方式引用环境变量中的api-key
,这样子后面如果你的 API Key 有变更的话就不用一个接口一个接口修改了,直接在环境变量中修改比较妥当。
总之就一句话,有密钥(API Key)就能发起请求并返回响应,没有就会报错。
四、通过编程语言发起请求
除此之外,你还可以通过代码的方式来发起请求。
在 Apifox 中,点击“实际请求->JavaScript->Axios”,将代码复制下来,粘贴到编辑器(如 vscode)中运行即可。你也可以选择其它语言,比如 Python、Java、PHP 等,这取决于你的系统是否配置有相关环境。
在 vscode 中新建一个 js 文件,然后安装需要的包(npm install axios),然后运行(node xxx.js)即可发起请求。
总结
Stable Diffusion 是一深度学习模型,用于生成图像。Stable Diffusion API 文档地址为https://stablediffusionapi.apifox.cn/。基本使用步骤是获取 API_KEY,配置于Apifox中,可通过接口文档发起请求,生成图像。推荐使用“动态值”引用环境变量中的 API_KEY,确保方便管理。
知识拓展:
- 推特(Twitter) API 使用教程,图文讲解 Twitter API 的用法
- 企业微信 API 接口调用教程,图文讲解企业微信 API 的用法
- Stable Diffusion API 使用概述:文生图(Text to Image)
- Stable Diffusion API 使用概述:图生图(Image to Image)
- Google Gemini API 接口调用教程,图文讲解