Flux API

Flux.1 是由前Stability AI工程师创立的初创公司Black Forest Labs开发的一种先进的文本到图像合成模型。TTAPI现支持API形式供开发者使用 Flux API 。

Flux 生成图像

POST https://api.ttapi.io/flux/generate

根据文本提示使用Flux.1模型生成图像。注意，该接口与Midjourney的区别是单次只能生成一张图片

Headers

Name	Value
Content-Type	application/json
TT-API-KEY	用于请求授权 TT-API 的API密钥

Body

参数	类型	是否必须	描述
prompt	string	是	生成图像描述词 注意：Flux支持多语言理解能力，但实测英文最佳。
size	string	否	图像尺寸，可选范围： 1024x1024 1024x1792 1792x1024 （即将启用）
aspect_ratio	string	否	图像比例，可选范围： 21:9, 16:9, 4:3, 3:2, 1:1, 2:3, 3:4, 9:16, 9:21（默认为1:1）
mode	string	是	模型版本，可选范围： flux1-dev flux1-schnell flux1-pro flux-kontext-pro flux-kontext-max
hookUrl	string	否	生成图像结果异步通知地址

注意：Flux生成图像接口同步返回的并不是任务的最终结果，任务的最终返回结果需要使用hookUrl参数接收异步通知，或者通过Flux查询任务结果接口进行查询。

请求示例

Python

import requests

endpoint = "https://api.ttapi.io/flux/generate"

headers = {
    "TT-API-KEY": your_key
}

data = {
    "prompt": "a cute cat",
    "mode": "flux1-dev"
}

response = requests.post(endpoint, headers=headers, json=data)

print(response.status_code)
print(response.json())

Node

const axios = require('axios');

let config = {
  method: 'post',
  url: 'https://api.ttapi.io/flux/generate',
  headers: { 
    'TT-API-KEY': 'your_key'
  },
  data : {
    "prompt": "a cute cat",
    "mode": "flux1-dev"
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.status));
})
.catch(function (error) {
  console.log(error);
});

返回示例

200

{
    "status": "SUCCESS",
    "message": "success",
    "data": {
        "jobId": "fac30d6c-d12b-465c-a580-8b1b3ae726e3"
    }
}

Flux 修改图像

POST https://api.ttapi.io/flux/edits

根据文本提示和上传垫图生成新图像

Headers

Name	Value
Content-Type	application/json
TT-API-KEY	用于请求授权 TT-API 的API密钥

Body multipart/form-data

参数	类型	是否必须	描述
image	file	是	垫图，支持多张
prompt	string	是	生成图像描述词 注意：Flux支持多语言理解能力，但实测英文最佳。
aspect_ratio	string	否	图像比例，可选范围： 21:9, 16:9, 4:3, 3:2, 1:1, 2:3, 3:4, 9:16, 9:21（默认为1:1）
mode	string	是	模型版本，可选范围： flux1-dev flux1-schnell flux1-pro flux-kontext-pro flux-kontext-max
hookUrl	string	否	生成图像结果异步通知地址

请求示例

Python

import requests

url = "https://api.ttapi.io/flux/edits"

data={
    "prompt": "a cute cat",
    "mode": "flux1-dev"
}
files=[
   ('image',('',open('','rb'),'application/octet-stream'))
]
headers = {
   'TT-API-KEY': 'Your Key'
}

response = requests.post(endpoint, headers=headers, json=data, files=files)

print(response.status_code)
print(response.json())

返回示例

200

{
    "status": "SUCCESS",
    "message": "success",
    "data": {
        "jobId": "fac30d6c-d12b-465c-a580-8b1b3ae726e3"
    }
}

Flux 获取图像结果

POST https://api.ttapi.io/flux/fetch

根据生成图像接口返回的jobId获取任务的最终结果，此接口免费。

Headers

Name	Value
Content-Type	application/json
TT-API-KEY	用于请求授权 TT-API 的API密钥

Body

参数	类型	是否必须	描述
jobId	string	是	生成图像接口同步返回的jobId

请求示例

Python

import requests

endpoint = "https://api.ttapi.io/flux/fetch"

headers = {
    "TT-API-KEY": your_key
}

data = {
    "jobId": "bf165abb-a7fa-4c77-a2e4-138baac1130d"
}

response = requests.post(endpoint, headers=headers, json=data)

print(response.status_code)
print(response.json())

Node

const axios = require('axios');

let config = {
  method: 'post',
  url: 'https://api.ttapi.io/flux/fetch',
  headers: { 
    'TT-API-KEY': 'your_key'
  },
  data : {
     "jobId": "bf165abb-a7fa-4c77-a2e4-138baac1130d"
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.status));
})
.catch(function (error) {
  console.log(error);
});

返回示例

200

{
    "status": "SUCCESS",
    "message": "success",
    "jobId": "bf165abb-a7fa-4c77-a2e4-138baac1130d",
    "data": {
        "mode": "flux-dev",
        "jobId": "bf165abb-a7fa-4c77-a2e4-138baac1130d",
        "prompt": "漂亮的亚洲女孩和一只猫的合影",
        "quota": "1",
        "size": "1024x1024",
        "imageUrl": "https://cdnb.ttapi.io/2024-09-10/9rk3gmw3m6sxm4r75my02r48jizyli1l.webp",
        "hookUrl": "https://webhook-test.com/d47a918bcf231bfd4dcd1f63c2cb4c80"
    }
}

返回JSON结构详解

name	value
status	ON_QUEUE //执行中 SUCCESS //成功 FAILED //失败
imageUrl	生成图像地址，有效期一个月，请自行转存
quota	实际消耗额度