PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Create Task
  • Get Started
    • Overview
    • Quickstart
    • Make Instruction: How to Use PiAPI to Build a Workflow on Make?
  • Endpoints
    • Song(Udio)
      • Song API Task Creation Examples
      • [Udio] Song Extend
      • Get Task
      • Create Task
      • [Udio] Generate Lyrics
    • Kling
      • Lipsync With PiAPI Kling API Examples
      • Motion Brush With PiAPI Kling API Example
      • Kling Elements Video Generation API
      • Kling Effects Video Generation
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Get Task
      • Create Task
      • Kling Virtual Try-On
    • Hailuo
      • Hailuo Director Mode Example
      • Generate Video
      • Get Task
    • Flux
      • Flux with LoRA and Controlnet
      • Available LoRA and Controlnet
      • Flux API with Redux Variation, Fill, Inpaint and Outpaint
      • Create Task
        • Text to Image
          POST
        • Image to Image
          POST
      • Get task
        GET
    • AI Hug
      • Get Task
      • Create Task
    • LLM
      • How To Find GPTs Gizmo Name?
      • How To Avoid Timeouts in Completion API
      • Deepseek Models
      • GPT-4o Image Generation API
      • LLM API | Basic Completions
      • Get Task
    • Midjourney
      • PiAPI Penalties on Midjourney Usage
      • Detailed Explaination on Midjourney Task Result
      • Midjourney V7 API Instructions
      • Create Task
        • Imagine
        • Upscale
        • Variation
        • Reroll
        • Describe
        • Seed
        • Blend
        • Inpaint
        • Outpaint
        • Pan
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Get Task
    • Faceswap
      • Multi Faceswap
      • Image Faceswap
      • Video Faceswap
      • Get Task
    • TTS
      • Zeroshot Text-to-Speech F5-TTS
      • Get Task
    • Trellis
      • Create Task
      • Get Task
    • Luma Dream Machine
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Create Task
      • Get Task
    • WanX
      • Available LoRA Types for Wanx
      • Generate WanX Task with LoRA Using PiAPI
      • Create Task
      • Get Task
    • Skyreels
      • Create Task
      • Get Task
    • Hunyuan Video
      • How to Make a Hunyuan API Call
      • Get Task
      • Generate Video
    • Mmaudio
      • Get Task
      • Generate Audio
    • DiffRhythm
      • Generate Audio
      • Get Task
    • Tools
      • File Upload API
      • Video Upscale
      • Video Upscale-Get Task
      • Remove Background API
      • Remove Background-Get Task
      • Segment With Prompt API
      • Segment With Prompt API-Get Task
      • Image Upscale(Super Resolution) API
      • Image Upscale-Get Task
    • PiAPI Account Management
      • PiAPI Account Info
      • Task List Info
      • User Task History
  • Resources
    • Change Log
    • Output Storage
    • Unified API Schema
    • Webhook
    • Bulk Generation Service
    • Billings
    • Workspace Manual
      • Host-your-account (HYA) | Back-up Account
      • Host-your-account (HYA) | Debug Checklist
      • Host-your-account (HYA) | Connected Account Status
    • Announcements
      • PiAPI 2025 January 1st Pricing Update
  • Legacy Documentation
    • Midjourney
      • Midjourney Webhook
      • Imagine
      • Reroll
      • Upscale
      • Variation
      • Inpaint
      • Outpaint
      • Pan
      • Describe
      • Blend
      • Seed
      • Fetch
      • Multi Fetch
      • Cancel
    • Face Swap
      • Video Faceswap
      • Multi-face-swap
      • Fetch
    • Dream Machine
      • Video Generation
      • Video Extend
      • Get Video Generation
    • Kling
      • Video Generation
      • Video Extend
      • Get Video Generation
  1. Create Task

Image to Image

POST
https://api.piapi.ai/api/v1/task
FLUX
This is provided as part of the Flux API from PiAPI. available models:
Qubico/flux1-dev
Qubico/flux1-schnell
Qubico/flux1-dev-advanced
Check Flux with LoRA and Controlnet to learn how to send Flux with LoRA and Controlnet task.
Check Flux with Redux and Fill to learn how to send Flux with variation, inpaint and out paint task.
Below is an example of image-to-image request and response.

Request

Header Params
X-API-Key
string 
required
Your API KEY used for request authorization
Body Params application/json
model
enum<string> 
required
the model name
Allowed values:
Qubico/flux1-devQubico/flux1-schnellQubico/flux1-dev-advanced
task_type
enum<string> 
required
Allowed values:
img2imgimg2img-loracontrolnet-lora
input
object 
required
the input param of the flux task
prompt
string 
required
negative_prompt
string 
optional
denoise
number 
optional
<= 1> 0
Default:
0.7
guidance_scale
number 
optional
Guidance scale for image generation. High guidance scales improve prompt adherence at the cost of reduced realism.
>= 1.5<= 5
image
string 
required
batch_size
number 
optional
number of images, only works for schnell at the moment. Price will be
batch_size * (price for one generation)
>= 1<= 4
Default:
1
lora_settings
array [object {3}] 
optional
control_net_settings
array[object (control_net_setting) {2}] 
required
config
object 
optional
webhook_config
object 
optional
Example
{
  "model": "Qubico/flux1-schnell",
  "task_type": "img2img",
  "input": {
    "prompt": "a bear",
    "image": "https://i.ibb.co/J7ZNgSG/01.jpg"
  },
  "config": {
    "webhook_config": {
      "endpoint": "https://webhook.site/xxxx",
      "secret": ""
    }
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'X-API-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "Qubico/flux1-schnell",
    "task_type": "img2img",
    "input": {
        "prompt": "a bear",
        "image": "https://i.ibb.co/J7ZNgSG/01.jpg"
    },
    "config": {
        "webhook_config": {
            "endpoint": "https://webhook.site/xxxx",
            "secret": ""
        }
    }
}'

Responses

🟢200Success
application/json
Body
code
integer 
required
data
object 
required
task_id
string 
required
model
string 
required
task_type
string 
required
status
enum<string> 
required
Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged
Allowed values:
CompletedProcessingPendingFailedStaged
input
object 
required
output
object 
required
meta
object 
required
detail
null 
required
logs
array [object] 
required
error
object 
required
message
string 
required
If you get non-null error message, here are some steps you chould follow:
Check our common error message
Retry for several times
If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.
Example
{
  "code": 200,
  "data": {
    "task_id": "1631d053-2352-4add-95cc-360fc52d5f89",
    "model": "Qubico/flux1-schnell",
    "task_type": "img2img",
    "status": "pending",
    "config": {
      "webhook_config": {
        "endpoint": "https://webhook.site/xxxx",
        "secret": ""
      }
    },
    "input": {
      "prompt": "a bear",
      "negative_prompt": "",
      "image": "https://i.ibb.co/J7ZNgSG/01.jpg",
      "width": 0,
      "height": 0,
      "steps": 0
    },
    "output": null,
    "meta": {
      "created_at": "2024-09-25T07:40:08.333962391Z",
      "started_at": "0001-01-01T00:00:00Z",
      "ended_at": "0001-01-01T00:00:00Z",
      "usage": {
        "type": "quota",
        "frozen": 0,
        "consume": 20000
      },
      "is_using_private_pool": false
    },
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}
Modified at 2025-02-07 07:45:08
Previous
Text to Image
Next
Get task