# PiAPI ## Docs - Get Started [PiAPI Documentation - the technical doc for APIs provided by PiAPI!PiAPI Documentation - the technical doc for APIs provided by PiAPI!](https://doc.builtopia.cc/docs/overview.md): An introduction to PiAPI's documentation, the key features (including Unified API, and Webhooks), and the list of available APIs include Midjourney, Flux, Kling, Dream Machine, Suno, LLM, etc. - Get Started [Quick Start - PiAPI docs](https://doc.builtopia.cc/docs/quickstart.md): Getting started quickly with PiAPI, generate your API Key, set base url, and make your first API call! - Get Started [PiAPI/Make Instruction of Flux API](https://doc.builtopia.cc/docs/piapi-make/make-insturcution.md): Recently, to help more content creators easily use PiAPI for their projects, Flux by PiAPI has officially launched on the Make platform! - [Endpoints](https://doc.builtopia.cc/docs/endpoints.md): - Endpoints > Song(Suno+Udio) [Song API Task Creation Examples(Suno and Udio)](https://doc.builtopia.cc/docs/music-api/music-task-examples.md): - Endpoints > Song(Suno+Udio) [[Udio] Song Extend](https://doc.builtopia.cc/docs/song-api/udio-song-extend.md): - Endpoints > Kling [Lipsync With PiAPI Kling API](https://doc.builtopia.cc/docs/kling-api/lipsync-examples.md): - Endpoints > Kling [Motion Brush With PiAPI Kling API Example](https://doc.builtopia.cc/docs/kling-api/motion-brush-examples.md): - Endpoints > Kling [Kling Elements Video Generation API](https://doc.builtopia.cc/docs/kling-api/kling-elements.md): - Endpoints > Kling [Kling Effects Video Generation](https://doc.builtopia.cc/docs/kling-api/kling-effects.md): - Endpoints > Hailuo [Hailuo Director Mode Example](https://doc.builtopia.cc/docs/hailuo-api/hailuo-director-mode.md): - Endpoints > Flux [Flux with LoRA and ControlNet - PiAPI docs](https://doc.builtopia.cc/docs/flux-with-lora-and-controlnet.md): How to use LoRA and ControlNet models with Flux? Check out this PiAPI docs for more! - Endpoints > Flux [Available LoRA and ControlNet - PiAPI docs ](https://doc.builtopia.cc/docs/available-lora-and-controlnet.md): This page has a list of all available LoRA and ControlNet models compatible with the Flux API. - Endpoints > Flux [Flux API with Redux and Fill](https://doc.builtopia.cc/docs/flux-redux-fill-variation-inpaint-outpaint.md): - Endpoints > LLM [GPTs Gizmo Name - LLM API - PiAPI docs](https://doc.builtopia.cc/docs/gpts-gizmo-name.md): How To Find the GPTs Gizmo Name for the GPTs API - Endpoints > LLM [How To Avoid Timeouts in Completion API](https://doc.builtopia.cc/docs/705454m0.md): - Endpoints > LLM [Deepseek Models](https://doc.builtopia.cc/docs/llm-api/deepseek.md): - Endpoints > LLM [GPT-4o Image Generation API](https://doc.builtopia.cc/docs/llm-api/gpt-4o-image-generation-api.md): - Endpoints > Midjourney [Penalties - Midjourney API - PiAPI docs](https://doc.builtopia.cc/docs/midjourney-api/penalties.md): The Penalties policies on Midjourney API Usage (including Bulk Generation Services, Error Task Penalty, Relax Task Penalty) from PiAPI - Endpoints > Midjourney [Task Result Explaination - Midjourney API - PiAPI docs](https://doc.builtopia.cc/docs/midjourney-api/task-result-explaination.md): The Detailed Explaination on Midjourney Task Result, including temporary urls, intermediate urls, from PiAPI - Endpoints > Midjourney [Midjourney V7 API Instructions](https://doc.builtopia.cc/docs/midjourney-api/v7.md): - Endpoints > WanX [PiAPI/WanX&LoRA Tutorial](https://doc.builtopia.cc/docs/wanx_lora/tutorial.md): To help users optimize WanX task creation, we've provided practical examples demonstrating how to construct proper API calls for better information reference. - Endpoints > Hunyuan Video [How to Make a Hunyuan API Call](https://doc.builtopia.cc/docs/hunyuan-api-doc.md): - Endpoints > Tools [File Upload API](https://doc.builtopia.cc/docs/tools/file-upload.md): - Resources [Change Log - PiAPI docs](https://doc.builtopia.cc/docs/changelog.md): The Change Log of PiAPI's API service, read about the latest updates and fixes on here! - Resources [Output Storage - PiAPI docs](https://doc.builtopia.cc/docs/output-storage.md): The output storage policy of PiAPI's API service, read about the how long we will store the outputs for. - Resources [Unified API schema - PiAPI docs](https://doc.builtopia.cc/docs/unified-api-schema.md): The Unified API schema of PiAPI - allows users to call all of our AI Model with just two endpoints. - Resources [Unified Webhook - PiAPI docs](https://doc.builtopia.cc/docs/unified-webhook.md): The Unified Webhook of PiAPI - allows users to receive timely task updates and notifications - Resources [Bulk Generation - PiAPI docs](https://doc.builtopia.cc/docs/bulk-generation.md): Bulk Generation Services offered by PiAPI - perfect for generating a large amount of out using Midjourney, Luma Dream Machine, Kling and/or Flux, - Resources [Billings - PiAPI docs](https://doc.builtopia.cc/docs/billings.md): PiAPI's billing info - learn how to choose usage modes and sucscription plans that suit you best. - Resources > Workspace Manual [Host-your-account using back-up account](https://doc.builtopia.cc/docs/hya-backup-account.md): Using back up account to increase service reliability - Resources > Workspace Manual [Host-your-account Debug Checklist](https://doc.builtopia.cc/docs/hya-debug-checklist.md): This checklist helps users to debug potential issues when connecting their accounts to their HYA seats. - Resources > Workspace Manual [Host-your-account Status of your Connected Accounts](https://doc.builtopia.cc/docs/hya-connected-account-status.md): This page is used to debug the different status of your hosted account. - Resources > Announcements [PiAPI 2025 January 1st Pricing Update](https://doc.builtopia.cc/docs/announcements/2025-jan-pricing-update.md): - Legacy Documentation > Midjourney [Midjourney Webhook - PiAPI docs](https://doc.builtopia.cc/docs/legacy/midjourney-api/webhook.md): The Midjourney webhook of PiAPI - allows users to receive timely task updates and notifications ## API Docs - Endpoints > Song(Suno+Udio) [Get Task - Suno API - PiAPI docs](https://doc.builtopia.cc/docs/suno-api/get-task.md): The Get Task Endpoint of Suno API from PiAPI - Endpoints > Song(Suno+Udio) [Create Task](https://doc.builtopia.cc/docs/music-api/create-task.md): :::info - Endpoints > Song(Suno+Udio) [Get Full Song - Suno API - PiAPI docs](https://doc.builtopia.cc/docs/suno-api/get-full-song.md): The Get Full Song Endpoint of Suno API from PiAPI - Endpoints > Song(Suno+Udio) [Song Extend - Suno API - PiAPI docs](https://doc.builtopia.cc/docs/suno-api/song-extend.md): The Music Generation Endpoint of Suno API from PiAPI - Endpoints > Song(Suno+Udio) [Upload Audio - Suno API - PiAPI docs](https://doc.builtopia.cc/docs/suno-api/upload-audio.md): The Upload Audio Endpoint of Suno API from PiAPI - Endpoints > Song(Suno+Udio) [Generate Lyrics - Suno API - PiAPI docs](https://doc.builtopia.cc/docs/suno-api/generate-lyrics.md): The Generate Lyrics Endpoint of Suno API from PiAPI - Endpoints > Song(Suno+Udio) [[Udio] Generate Lyrics](https://doc.builtopia.cc/docs/song-api/udio-generate-lyrics.md): Uses Udio to synthesize lyrics. - Endpoints > Kling > Cancel Task [Cancel Multiple Tasks - Kling API - PiAPI docs](https://doc.builtopia.cc/docs/kling-api/cancel-tasks.md): The Cancel Multiple Tasks Endpoint of Kling API from PiAPI - Endpoints > Kling > Cancel Task [Cancel Single Task - Kling API - PiAPI docs](https://doc.builtopia.cc/docs/kling-api/cancel-task.md): The Cancel Single Task Endpoint of Kling API from PiAPI - Endpoints > Kling [Get Task - Kling API - PiAPI docs](https://doc.builtopia.cc/docs/kling-api/get-task.md): The Get Task Endpoint of Kling API from PiAPI - Endpoints > Kling [Create Task - Kling API - PiAPI docs](https://doc.builtopia.cc/docs/kling-api/create-task.md): The Create Task Endpoint of Kling API from PiAPI - Endpoints > Kling [Kling Virtual Try-On](https://doc.builtopia.cc/docs/kling-api/virtual-try-on-api.md): This is the api for Kling's Virtual Try On, $0.07 for each output image for PAYG. You can also use this endpoint in HYA mode. - Endpoints > Hailuo [Hailuo API Generate Video - PiAPI](https://doc.builtopia.cc/docs/hailuo-api/generate-video.md): Hailuo API Generate Video - PiAPI - Endpoints > Hailuo [PiAPI/Hailuo API-Get Task](https://doc.builtopia.cc/docs/hailuo-api/get-task.md): This endpoint from PiAPI's Hailuo API retrieves the output of the Hailuo task. - Endpoints > Flux > Create Task [Create text-to-image task - Flux API - PiAPI docs](https://doc.builtopia.cc/docs/flux-api/text-to-image.md): The Create text-to-image endpoint of the Flux API - Endpoints > Flux > Create Task [Create text-to-image task - Flux API - PiAPI docs](https://doc.builtopia.cc/docs/flux-api/image-to-image.md): The Create text-to-image endpoint of the Flux API - Endpoints > Flux [Get Task - Flux API - PiAPI docs](https://doc.builtopia.cc/docs/flux-api/get-task.md): The Get Task endpoint of the Flux API - Endpoints > AI Hug [Get task - AI Hug API - PiAPI docs](https://doc.builtopia.cc/docs/ai-hug-api/get-task.md): The Get Task endpoint of the AI Hug API - Endpoints > AI Hug [AI HUG API Create Task - PiAPI](https://doc.builtopia.cc/docs/ai-hug-api/create-task.md): AI HUG API Create Task - PiAPI - Endpoints > LLM [Completions - LLM API - PiAPI docs](https://doc.builtopia.cc/docs/llm-api/completions.md): The Completion Endpoint of LLM API from PiAPI - Endpoints > LLM [Get Task](https://doc.builtopia.cc/docs/14943756e0.md): - Endpoints > Midjourney > Create Task [Imagine Endpoint -Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/imagine.md): The Imagine Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Upscale Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/upscale.md): Upscale Endpoint - Midjourney API - PiAPI Docs - Endpoints > Midjourney > Create Task [variation Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/variation.md): The variation Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [reroll Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/reroll.md): The reroll Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Describe Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/describe.md): The Describe Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Seed Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/seed.md): The Seed Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Blend Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/blend.md): The Blend Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Inpaint Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/inpaint.md): The Inpaint Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Outpaint Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/outpaint.md): The outpaint Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Create Task [Pan Endpoint - Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/pan.md): The Pan Endpoint of Midjourney API of PiAPI's docs - Endpoints > Midjourney > Cancel Task [Cancel Single Task - Midjourney API - PiAPI docs](https://doc.builtopia.cc/docs/midjourney-api/cancel-task.md): The Cancel Single Task Endpoint of Midjourney API from PiAPI - Endpoints > Midjourney > Cancel Task [Cancel Multiple Tasks - Midjourney API - PiAPI docs](https://doc.builtopia.cc/docs/midjourney-api/cancel-tasks.md): The Cancel Multiple Tasks Endpoint of Midjourney API from PiAPI - Endpoints > Midjourney [Get task - Midjourney API - PiAPI docs](https://doc.builtopia.cc/docs/midjourney-api/get-task.md): The Get Task Endpoint of Midjourney API from PiAPI - Endpoints > Faceswap [PiAPI/Multi Faceswap](https://doc.builtopia.cc/docs/multi-face-swap/create-task.md): This async endpoint from swaps the face from the swap_image to the target_image. - Endpoints > Faceswap [Create Task - Faceswap API - PiAPI docs](https://doc.builtopia.cc/docs/faceswap-api/create-task.md): The Create Task Endpoint of Faceswap API from PiAPI - Endpoints > Faceswap [Video Faceswap API](https://doc.builtopia.cc/docs/faceswap-api/video-faceswap.md): PiAPI's Video Face Swap service enables face replacement in videos using advanced facial recognition and swapping technology. - Endpoints > Faceswap [Get Task - Faceswap API - PiAPI docs](https://doc.builtopia.cc/docs/faceswap-api/get-task.md): The Get Task Endpoint of Faceswap API from PiAPI - Endpoints > TTS [F5 TTS Zeroshot TTS API](https://doc.builtopia.cc/docs/tts-api/f5-tts.md): # PiAPI Text-to-Speech API Documentation - Endpoints > TTS [Get Task](https://doc.builtopia.cc/docs/14943660e0.md): This endpoint from [PiAPI's TTS API](https://piapi.ai/docs/tts-api/f5-tts) retrieves the output of a TTS task. - Endpoints > Trellis [Create Task - Trellis API](https://doc.builtopia.cc/docs/trellis-api/create-task.md): Create Task - Trellis of PiAPI - Endpoints > Trellis [Trellis/PiAPI-Get Task](https://doc.builtopia.cc/docs/trellis-api/get-task.md): This endpoint from PiAPI's Trellis API retrieves the output of a Trellis 3D model generation task. - Endpoints > Luma Dream Machine > Cancel Task [Cancel Multiple Tasks - Dream Machine API - PiAPI docs](https://doc.builtopia.cc/docs/dream-machine/cancel-tasks.md): The Cancel Multiple Tasks Endpoint of gDream Machine API from PiAPI - Endpoints > Luma Dream Machine > Cancel Task [Cancel Single Task - Luma API - PiAPI docs](https://doc.builtopia.cc/docs/dream-machine/cancel-task.md): The Cancel Single Task Endpoint of Luma API from PiAPI - Endpoints > Luma Dream Machine [Create Task - Luma API - PiAPI docs](https://doc.builtopia.cc/docs/dream-machine/create-task.md): The Create Task Endpoint of Luma API from PiAPI - Endpoints > Luma Dream Machine [Get Task - Dream Machine API - PiAPI docs](https://doc.builtopia.cc/docs/dream-machine/get-task.md): The Get Task Endpoint of Dream Machine API from PiAPI - Endpoints > WanX [Create Task](https://doc.builtopia.cc/docs/wanx-api/create-task.md): ## Overview - Endpoints > WanX [PiAPI/Wanx-Get Task](https://doc.builtopia.cc/docs/wanx-api/get-task.md): This endpoint from PiAPI's Wanx API retrieves the output of the Wanx task. - Endpoints > Skyreels [Skyreels API Create Task - PiAPI](https://doc.builtopia.cc/docs/skyreels-api/create-task.md): Skyreels API Create Task - PiAPI - Endpoints > Skyreels [PiAPI/Skyreels-Get Task](https://doc.builtopia.cc/docs/skyreels-api/get-task.md): This endpoint from PiAPI's Skyreels API retrieves the output of the Skyreels task. - Endpoints > Hunyuan Video [Hunyuan API-Get Task](https://doc.builtopia.cc/docs/hunyuan-api/get-task.md): This endpoint from PiAPI's Hunyuan API retrieves the output of the Hunyuan task for users. - Endpoints > Hunyuan Video [Hunyuan txt2video API](https://doc.builtopia.cc/docs/hunyuan-video/txt2video-api.md): # Hunyuan Video Generation API Documentation - Endpoints > Mmaudio [Mmaudio API-Get Task](https://doc.builtopia.cc/docs/mmaudio-api/get-task.md): This endpoint from PiAPI's mmaudio API retrieves the output of the mmaudio task where users could check their task output. - Endpoints > Mmaudio [Mmaudio API-Generate Audio based on Video](https://doc.builtopia.cc/docs/mmaudio-api/create-task.md): This endpoint from PiAPI's mmaudio API can generate audio based on video and prompt provided. - Endpoints > DiffRhythm [PiAPI/DiffRhythm-Create Task](https://doc.builtopia.cc/docs/diffrhythm-api/create-task.md): This endpoint from PiAPI's DiffRhythm API can generate audio based on prompt or reference audio with lyrics. - Endpoints > DiffRhythm [PiAPI/DiffRhythm-Get Task](https://doc.builtopia.cc/docs/diffrhythm/get-task.md): This endpoint from PiAPI's DiffRhythm API retrieves the output of the DiffRhythm task where users could check their task output. - Endpoints > Tools [Video Upscale](https://doc.builtopia.cc/docs/tools/video-upscale-api.md): ## Overview - Endpoints > Tools [PiAPI/Video Upscale-Get Task](https://doc.builtopia.cc/docs/video-upscale/get-scale.md): This endpoint from PiAPI's Video Upscale API retrieves the output of the Video Upscale task where users could check their task output. - Endpoints > Tools [Remove Background API](https://doc.builtopia.cc/docs/image-editing-api/remove-background-api.md): Pricing: $0.001/generation - Endpoints > Tools [PiAPI/Remove Background-Get Task](https://doc.builtopia.cc/docs/remove-background/get-task.md): This endpoint from PiAPI's Remove Background API retrieves the output of the Remove Background task where users could check their task output. - Endpoints > Tools [Segment With Prompt API](https://doc.builtopia.cc/docs/image-editing-api/segment-with-prompt-api.md): | Model | Price (USD) | - Endpoints > Tools [PiAPI/Segment With Prompt-Get Task](https://doc.builtopia.cc/docs/segment-with-prompt/get-task.md): This endpoint from [PiAPI's Segment With Prompt API] retrieves the output of the Segment With Prompt task where users could check their task output. - Endpoints > Tools [Image Upscale(Super Resolution) API](https://doc.builtopia.cc/docs/image-editing-api/super-resolution-api.md): ## Pricing - Endpoints > Tools [PiAPI/Image Upscale-Get Task](https://doc.builtopia.cc/docs/image-upscale/get-task.md): This endpoint from PiAPI's Image-Upscale API retrieves the output of the Image Upscale task where users could check their task output. - Endpoints > PiAPI Account Management [PiAPI Account Info](https://doc.builtopia.cc/docs/account-info-api.md): Use the following endpoint to retrieve information such as account_name, account_id, remaining credits based on an API KEY. - Endpoints > PiAPI Account Management [Task List Info](https://doc.builtopia.cc/docs/task-list-api.md): Get all your running jobs on PiAPI - Endpoints > PiAPI Account Management [PiAPI/User History Query API](https://doc.builtopia.cc/docs/piapi-user-history-query.md): To enable users to access their history more conveniently and efficiently, we have provided a User History Query API. - Legacy Documentation > Midjourney [Imagine Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/imagine.md): The Legacy Imagine Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [reroll Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/reroll.md): The Legacy reroll Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Upscale Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/upscale.md): The Legacy upscale Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [variation Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/variation.md): The Legacy variation Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Inpaint Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/inpaint.md): The Legacy Inpaint Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Outpaint Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/outpaint.md): The Legacy outpaint Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Pan Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/pan.md): The Legacy Pan Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Describe Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/describe.md): The Legacy Describe Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Blend Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/blend.md): The Legacy Blend Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Seed Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/midjourney-api/seed.md): The Legacy Seed Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Fetch Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/fetch.md): The Legacy Fetch Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Multi Fetch Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/multi-fetch.md): The Legacy Multi Fetch Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Midjourney [Cancel Endpoint - Legacy Midjourney API - PiAPI Docs ](https://doc.builtopia.cc/docs/midjourney-api/cancel.md): The Legacy cancel Endpoint of Midjourney API of PiAPI's docs - Legacy Documentation > Face Swap [Faceswap Endpoint - Legacy Faceswap API - PiAPI Docs ](https://doc.builtopia.cc/docs/legacy/faceswap-api/faceswap.md): The Legacy Faceswap Endpoint of Faceswap API of PiAPI's docs - Legacy Documentation > Face Swap [Multi-face-swap](https://doc.builtopia.cc/docs/15210914e0.md):