PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Get Started
  • Get Started
    • Overview
    • Quickstart
  • Endpoints
    • 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
        GET
      • Create Task
        POST
    • LLM
      • How To Find GPTs Gizmo Name?
      • How To Avoid Timeouts in Completion API
      • Deepseek Models
      • LLM API | Basic Completions
        POST
      • Get Task
        GET
    • Midjourney
      • PiAPI Penalties on Midjourney Usage
      • Detailed Explaination on Midjourney Task Result
      • Create Task
        • Imagine
          POST
        • Upscale
          POST
        • Variation
          POST
        • Reroll
          POST
        • Describe
          POST
        • Seed
          POST
        • Blend
          POST
        • Inpaint
          POST
        • Outpaint
          POST
        • Pan
          POST
      • Cancel Task
        • Cancel Task
          DELETE
        • Cancel Tasks
          DELETE
      • Get Task
        GET
    • Faceswap
      • Image Faceswap
        POST
      • Video Faceswap
        POST
      • Get Task
        GET
    • TTS
      • Zeroshot Text-to-Speech F5-TTS
        POST
      • Get Task
        GET
    • Song(Suno+Udio)
      • Song API Task Creation Examples(Suno and Udio)
      • [Udio] Song Extend
      • Get Task
        GET
      • Create Task
        POST
      • [Suno] Generate Full Song
        POST
      • [Suno] Song Extend
        POST
      • [Suno] Upload Audio
        POST
      • [Suno] Generate Lyrics
        POST
      • [Udio] Generate Lyrics
        POST
    • Trellis
      • Create Task
        POST
      • Get Task
        GET
    • Luma Dream Machine
      • Cancel Task
        • Cancel Task
          DELETE
        • Cancel Tasks
          DELETE
      • Create Task
        POST
      • Get Task
        GET
    • 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 Tasks
          DELETE
        • Cancel Task
          DELETE
      • Get Task
        GET
      • Create Task
        POST
      • Kling Virtual Try-On
        POST
    • Hailuo
      • Hailuo Director Mode Example
      • Generate Video
        POST
      • Get Task
        GET
    • Skyreels
      • Create Task
        POST
      • Get Task
        GET
    • WanX
      • Create Task
        POST
      • Get Task
        GET
    • Hunyuan Video
      • Generate Video
        POST
      • Get Task
        GET
    • PiAPI Account Management
      • PiAPI Account Info
        GET
      • Task List Info
        GET
    • Mmaudio
      • Get Task
        GET
      • Generate Audio
        POST
    • DiffRhythm
      • Generate Audio
        POST
      • Get Task
        GET
    • Tools
      • File Upload API
      • Video Upscale
        POST
      • Video Upscale-Get Task
        GET
      • Remove Background API
        POST
      • Remove Background-Get Task
        GET
      • Segment With Prompt API
        POST
      • Segment With Prompt API-Get Task
        GET
      • Image Upscale(Super Resolution) API
        POST
      • Image Upscale-Get Task
        GET
  • 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
        POST
      • Reroll
        POST
      • Upscale
        POST
      • Variation
        POST
      • Inpaint
        POST
      • Outpaint
        POST
      • Pan
        POST
      • Describe
        POST
      • Blend
        POST
      • Seed
        POST
      • Fetch
        POST
      • Multi Fetch
        POST
      • Cancel
        POST
    • Face Swap
      • Video Faceswap
        POST
      • Multi-face-swap
        POST
      • Fetch
        GET
    • Dream Machine
      • Video Generation
        POST
      • Video Extend
        POST
      • Get Video Generation
        GET
    • Kling
      • Video Generation
        POST
      • Video Extend
        POST
      • Get Video Generation
        GET
  1. Get Started

Overview

What is PiAPI?#

PiAPI is a comprehensive platform offering a wide range of large-scale AI model APIs, designed to help developers easily integrate advanced AI functionalities into their applications.

Key Features#

1
Unified API Schema
What truly sets PiAPI apart is our unified API architecture, which simplifies the process: with just two endpoints, you can handle the full spectrum of task creation and retrieval. For an in-depth explanation, explore our Unified API Schema on the unified API framework.
2
Broad Model Selection
Access a diverse range of models for various AI tasks.
3
Webhook
We offer Webhook services integrated with our Unified API Schema for timely update and notifications.

Available APIs#

Image Models
Video Models
Audio Models
LLM

What is Pay-as-you-go vs Host-your-account?#

Pay-as-you-go: or sometimes referred to as "PPU" or "Pay-per-use", is a service option where you don’t have to have your own Midjourney/ChatGPT/Kling/Luma/Suno/etc accounts depending on the API you want to use, and you will be using the account pool operated by us and it will consume your credits (which you can get more by topping up). Thus, all the jobs submitted will be processed by our accounts.
The Pay-as-you-go service option will consume your PiAPI credits, which you can top-up on the Workspace.

Host-your-account: sometimes referred to as "BYOA" or "Bring-your-own-account", is a service option where you do need to have and operate your own Midjourney/ChatGPT/Kling/Luma/Suno/etc accounts, and then subscribe to a seat or multiple seats on our platform for that particular API, connect your account to that seat, and then start using the API. Thus, all the jobs submitted will be processed by your own accounts.
The Host-your-account service option will require you to subscribe to Host-your-account seats for that particular API you want to use. You will not need to top-up PiAPI credits for Host-your-account service option.

Reliability: For APIs where both service options are available, the most reliable way is to for you to use both Pay-per-use and Host-your-account service options to reduce the possibility of downtime associated with account operation related issues. For example, you could primarily use Pay-as-you-go and have your own Host-your-account as backup; or in the case of Midjourney API, you could use your Host-your-accounts and failover to our Pay-as-you-go (there is a toggle for this failover logic on the Workspace.).

Quick Start#

To start using the PiAPI, follow the Quickstart guide to set up your environment and make your first API call.
Modified at 2024-11-09 03:54:27
Next
Quickstart