Docs
Flux API

Flux API (Flux.1 API)

Documentation on our Flux API

This service is brought to you by GoAPI with Qubico's inference hardware. This api is using Qubico unified task structure.


Flux API (Unified task creation)

POST

https://api.goapi.ai/api/v1/task

create a task

Parameters:

Header
NameTypeRequiredDescription
X-API-Keystring✔️Your GoAPI Key used for request authorization
Body
NameTypeRequiredDescription
modelstring✔️the model name, can be `Qubico/flux1-dev` or `Qubico/flux1-schnell`
task_typestring✔️type the task, can only be `txt2img`
inputjson✔️the input param of the flux task

Response Codes:

200: OK
Successful Response
400: Bad Request
The request format does not meet the requirements.
401: Unauthorized
The API key is incorrect
500: Internal Server Error
Service is experiencing an error

Input Json Example

{
        "prompt": "a little cute bear"
}

Request Example

import requests
import json
 
url = "https://api.goapi.ai/api/v1/task"
 
payload = json.dumps({
    "model": "Qubico/flux1-dev", //for schnell use `Qubico/flux1-schnell`
    "task_type": "txt2img",
    "input": {
        "prompt": "a little cat"
    } 
})
headers = {
  'X-API-Key': 'YOU-GOAPI-KEY',
  'Content-Type': 'application/json'
}
 
response = requests.request("POST", url, headers=headers, data=payload)
 
print(response.text)

Response Example (Unified Task Result)

{
    "code": 200,
    "message": "success",
    "data": {
        "task_id": "0f647527-12bd-48b1-b813-111111111",
        "model": "Qubico/flux1-dev", 
        "task_type": "txt2img",
        "status": "", // pending/processing/failed/completed
        "input": {}, 
        "output": {}, 
        "meta": { 
        },
        "logs": [],
        "error": {
            "code": 1100,
            "message": ""
        } 
    }
}

Get Task Result API (Unified Get Task API)

GET

https://api.goapi.ai/api/v1/task/{task_id}

get flux task progress or result

Parameters:

Header
NameTypeRequiredDescription
X-API-Keystring✔️Your GoAPI Key used for request authorization
Body
NameTypeRequiredDescription

Response Codes:

200: OK
Successful Response
400: Bad Request
The request format does not meet the requirements.
401: Unauthorized
The API key is incorrect
500: Internal Server Error
Service is experiencing an error

Request Example

import requests
 
url = "https://api.goapi.ai/api/v1/task/56ea8da3-8507-4118-9f1e-111111111111"
 
payload={}
headers = {
  'X-API-Key': 'YOUR_GOAPI_KEY',
  'Content-Type': 'application/json'
}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)

Response Example (Unified Task Result)

{
    "code": 200,
    "message": "success",
    "data": {
        "task_id": "0f647527-12bd-48b1-b813-111111111",
        "model": "Qubico/flux1-dev", 
        "task_type": "txt2img",
        "status": "", // pending/processing/failed/completed
        "input": {}, 
        "output": {}, 
        "meta": { 
        },
        "logs": [],
        "error": {
            "code": 1100,
            "message": ""
        } 
    }
}

PenaltiesImage Editing API