1. 获取 API KEY
在调用 API 之前,你需要获取 TT-API-KEY 用于身份认证。获取方式:Step 1:注册你的账户
注册你的账户
注册你的账户
打开 TTAPI 官网 ,右上角点击 SIGN IN ,或者直接打开 TTAPI Dashboard 登录页面,选择 Github 或者 Google 账户注册/登录。
KEY与额度
KEY与额度
- 注册成功后,将会收到TTAPI的官方邮件通知并跳转 Dashboard 主页,默认生成一个 TT-API-KEY,这个key将会应用在TTAPI中所有接口的鉴权
- 并且默认获得 30 quota (≈$0.3) 的试用额度,页面中会显示当前剩余额度
Step 2:使用你的账户
重置你的 TT-API-KEY
重置你的 TT-API-KEY
我们建议首次注册使用之前修改您的默认TT-API-KEY,控制面板主页点击“RESET”,确认并提交修改您的默认KEY
修改你的账户密码
修改你的账户密码
如果您后续不希望使用 github 或者 google 一键登录,可以在 登录页面 点击“忘记密码?”,通过接收注册邮箱中的验证码修改您的登录密码,后续可以进行账户密码登录
2. 设置请求头
所有 API 请求都必须在请求头中包含 TT-API-KEY 进行身份认证。3. 发送第一个请求
第一步:发送生成请求
下面是一个简单的图像生成 API 调用示例。响应示例
第二步:检查任务状态
通过第一步返回的任务ID(jobId)查询生成结果:响应示例
任务状态说明
PENDING_QUEUE | 任务正在队列中等待 |
ON_QUEUE | 任务正在处理中 |
SUCCESS | 任务成功完成 |
FAILED | 任务执行失败 |
