PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Get Started
  • 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 Tasks
        • Cancel Task
      • 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
        • Image to Image
      • Get task
    • AI Hug
      • Get Task
      • Create Task
    • LLM
      • Use Cases for GPT-4o Image API
      • How To Avoid Timeouts in Completion API
      • 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 Tasks
        • Cancel Task
      • Create Task
      • Get Task
    • WanX
      • Available LoRA Types for Wanx
      • Generate WanX Task with LoRA Using PiAPI
      • Use Cases for Wanx LoRA
      • Create Task
      • Get Task
    • Skyreels
      • Create Task
      • Get Task
    • Framepack
      • 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
    • PiAPI MCP Server
    • 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. Get Started

Quickstart

Let's make your first API call to access AI functionalities using the service from PiAPI!

Generate an API key#

💡
What is API key?
An API key is a secure credential that allows your code to interact with our API. Never share your API key with anyone, as it can be exploited without your knowledge.
1.
Create an account : Go to PiAPI workspace and log in with your github account.
2.
Create an API key: After logged in, navigate to the API key in workspace and generate one.

Set Base URL#

This is the URL to be used for all of our API calls:
https://api.piapi.ai

Make your first API call#

Let's take Flux API for an example.
1.
Set URL endpoint: With our Unified API Schema, users could interact with all models and services through just two endpoints: create task and get task.
Here we want to create a Flux text-to-imagetask, so the endpoint should be:
https://api.piapi.ai/api/v1/task
2.
Set the header: In most cases, you will need an API key for authorization. Remember to replace the YOUR_API_KEY with your own API key. The headers look like this:
3.
Set the request Body: APIs of Unified API schema share the same request and response format. you will need to specify three main components:
model: The specific model you wish to interact with. Here we set to Qubico/flux1-schnell.
task_type: The type of task. Here we set to txt2img.
input: The inputs specific to the task and model.prompt is required, Let's set to "a bear" for example.
{
   "model": "flux1-schnell",
   "task_type": "txt2img",
   "input": {
      "prompt": "a bear",
   }
}
TIP
For the introduction of params needed in request body, refer to the documentation of specific endpoint you want to interact with.
You can check Flux Text to Image endpoint doc about the params above.
4.
Send the request:
And you will get a response in unified response schema. Now you have made your first API call. Happy intergrating!

Alternate Domains#

Here are the available domains for all of our API endpoints. we recommend you to experiment with them and change the domains as needed:
1.
api.piapi.ai - the primary domain for all API endpoints
Modified at 2025-01-09 07:19:04
Previous
Overview
Next
Make Instruction: How to Use PiAPI to Build a Workflow on Make?