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

Outpaint

POST
/mj/v2/outpaint
legacy/Midjourney
This endpoint from PiAPI's Midjourney API extends the canvas of an upscaled image beyond the its original size while retaining the details of the original image. This endpoint corresponds to the Zoom Out tool from the official Midjourney.

Request

Header Params
X-API-Key
string 
required
Insert your API Key here
Example:
{{x-api-key}}
Body Params application/json
origin_task_id
string 
required
The task ID of the parent task.
zoom_ratio
string 
optional
This parameter controls how much to zoom out on an image
Valid values:
For Midjourney Discord button "zoom out 1.5x" - use: 1.5
For Midjourney Discord button "zoom out 2x" - use: 2
For Midjourney Discord button "custom zoom" - use: (1, 2]
For Midjourney Discord button "make square" - use: 1
aspect_ratio
string 
optional
This parameter dictating the ouput image's aspect ratio value. Default value: 1:1.
prompt
string 
optional
This prompt for this operation.
skip_prompt_check
boolean 
optional
Use this parameter to skip our internal prompt check. Default value: False.
webhook_endpoint
string 
optional
Task notifications will be sent to the indicated address. The acceptable address can either be a domain or port 443.
webhook_secret
string 
optional
This value will be passed as the x-webhook-secret field in the headers as part of the response.
Example
{
  "origin_task_id": "ba9e9dc2************90f6134ca837",
  "zoom_ratio": "2",
  "aspect_ratio": "16:9",
  "prompt": "a cute dog with a sunglasses",
  "skip_prompt_check": false,
  "webhook_endpoint": "",
  "webhook_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/mj/v2/outpaint' \
--header 'X-API-Key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "origin_task_id": "ba9e9dc2************90f6134ca837",
    "zoom_ratio": "2",
    "aspect_ratio": "16:9",
    "prompt": "a cute dog with a sunglasses",
    "skip_prompt_check": false,
    "webhook_endpoint": "",
    "webhook_secret": ""
}'

Responses

🟢200OK
application/json
OK - Successful response
Body
task_id
string 
optional
status
string 
optional
message
string 
optional
Example
{
  "task_id": "2f6c6326***************793881539f2c",
  "status": "success",
  "message": ""
}
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2024-09-24 02:23:40
Previous
Inpaint
Next
Pan