stability-sdk

环境要求

• Python 3 环境（需可运行 python3 -m 模块）
• 已安装 pip，可执行 pip install
• Stability AI 账号并获取 API Key（platform.stability.ai）
• 可访问网络与 grpc.stability.ai:443 通信

安装与启动步骤

1. 1获取 API Key

   按 Platform 官方认证文档的指引注册并获取 API Key，后续调用必须用到，注意妥善保管。

2. 2安装 SDK

   从 PyPI 安装官方 stability-sdk 包，安装后即可使用命令行客户端和 Python API。

   pip install stability-sdk

   复制

3. 3设置环境变量

   STABILITY_KEY 填你自己的密钥；STABILITY_HOST 默认已是 grpc.stability.ai:443，一般按默认值写即可。

   export STABILITY_HOST=grpc.stability.ai:443
   export STABILITY_KEY=sk-xxxxxxxx

   复制

4. 4生成第一张图

   执行文本生成图像，默认 1024x1024，生成的 PNG 会写入当前目录。

   python3 -m stability_sdk generate -W 1024 -H 1024 "A stunning house."

   复制

5. 5放大图片

   对已有图片做放大（upscale），通过 -i 指定本地图片的完整路径。

   python3 -m stability_sdk upscale -i "/path/to/image.png"

   复制

6. 6启动动画界面

   需要动画 UI 时先装 anim_ui 附加依赖，再用 animate 命令启动图形界面。

   pip install stability-sdk[anim_ui]
   python3 -m stability_sdk animate --gui

   复制

7. 7查看全部参数

   用 -h 查看 generate 支持的高度、采样器、风格预设、种子、引擎等选项。

   python3 -m stability_sdk generate -h

   复制

关键配置

如何确认成功

命令执行完且无报错，当前目录出现生成的 PNG 图片文件即表示成功。

常见问题

注意事项

• STABILITY_HOST 默认就是 grpc.stability.ai:443，除非有特殊需求否则不必手动设置。
• API Key 属于敏感信息，不要硬编码进代码或提交到 Git 仓库。
• 如需从源码以可编辑模式安装，README 给出的是在 venv 中执行 pyenv/bin/pip3 install -e .，需在项目仓库目录下进行。
• 更多 API 用法请查阅 platform.stability.ai 的完整文档。