PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Midjourney
  • 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
        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
      • Multi-face-swap
      • Fetch
    • Dream Machine
      • Video Generation
      • Video Extend
      • Get Video Generation
    • Kling
      • Video Generation
      • Video Extend
      • Get Video Generation
  1. Midjourney

Midjourney Webhook

With PiAPI's Midjouerney API webhook , you can automatically receive notifications on the outcomes of tasks, whether they complete successfully or encounter errors, ensuring you stay informed in real time.

Set up webhook#

To enable webhook notifications, include the following fields in the request body:
{
   "webhook_endpoint": "http://example.com",
   "webhook_secret": "hello",
    "notify_progress": true
}
propertiestyperequired?Explanation
webhook_endpointstringrequiredThis is the URL where webhook notifications will be sent. It needs to be a valid URL that begins with either http:// or https:// and uses port 80 or 443.
webhook_secretstringoptionalA secret key defined by the user. This key is included in the header of webhook requests as x-webhook-secret, allowing the user to verify that the request comes from a trusted source.
notify_progressbooleanoptionalDefault to false. If set to true, progress update webhook for the task will also be sent, resulting in multiple webhook events and additional statuses for a single task that the user will need to manage.

Receive notifications#

Webhook notification will send http POST request to your webhook endpoint.
The request body corresbonds to v2 fetch API response JSON format.

Retry#

Once you recieve the webhook notification, quicikly respond with 200 HTTP status code for successful delivery. Otherwise it will retry.

intermediate_urls working with webhook#

1.
Firstly, check https://piapi.ai/pricing to see whether you have access to the intermediate url parameter.
2.
Next, if notify_progress is set to true, then our application will trigger the webhook to send you a HTTPS POST every time the task_progress parameter value updates. Please note that task_progress does not equal to valid intermediate urls available.
intermediate_urls

Compatible endpoints#

The following APIs are compatible with these two fields:
1.
MJ API V2
Imagine
Upscale
Variation
Outpaint
Pan
Describe
Blend
Reroll
Seed
Modified at 2024-10-17 15:25:24
Previous
PiAPI 2025 January 1st Pricing Update
Next
Imagine