REST API Reference

Updated on December 14, 2024

The Openjourney REST API offers the best AI tools.

All resources that you will most likely use are prefixed with a star symbol (⭐).

While integrating the REST API, you may be interested in the following guides:

FLUXin Models

1.1 Pro Ultra

POST
/v1/flux/1.1/pro-ultra

Most advanced model offering exceptional quality up to 4 megapixels, featuring Ultra and Raw modes for superior detail and natural aesthetics.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait, Landscape and Wide Landscape

raw
boolean

Less processed and natural-looking

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/1.1/pro-ultra
HTTP
Request
(loading)
Response
(loading)

1.1 Pro

POST
/v1/flux/1.1/pro

High-performance model delivering professional-grade outputs with excellent image quality and strong prompt adherence.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait, Landscape and Wide Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/1.1/pro
HTTP
Request
(loading)
Response
(loading)

Pro

POST
/v1/flux/pro

Flagship model offering state-of-the-art performance with top-tier prompt following and visual quality.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/pro
HTTP
Request
(loading)
Response
(loading)

Fill Pro

POST
/v1/flux/fill-pro

State-of-the-art inpainting and outpainting model for seamless image editing and extension.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/fill-pro
HTTP
Request
(loading)
Response
(loading)

Depth Pro

POST
/v1/flux/depth-pro

Professional depth-aware model enabling superior 3D understanding and spatial composition.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/depth-pro
HTTP
Request
(loading)
Response
(loading)

Canny Pro

POST
/v1/flux/canny-pro

Advanced edge-detection model for precise structural control.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/canny-pro
HTTP
Request
(loading)
Response
(loading)

Dev

POST
/v1/flux/dev

Open-weight model balancing quality and performance, designed for non-commercial applications.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/dev
HTTP
Request
(loading)
Response
(loading)

Dev LoRA

POST
/v1/flux/dev-lora

An adaptation of the FLUX Dev model that incorporates Low-Rank Adaptation (LoRA) technology. This allows for efficient customization of the model for specific styles or domains while maintaining high-quality outputs.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/dev-lora
HTTP
Request
(loading)
Response
(loading)

Fill Dev

POST
/v1/flux/fill-dev

Development version of the inpainting model for testing and prototyping.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/fill-dev
HTTP
Request
(loading)
Response
(loading)

Depth Dev

POST
/v1/flux/depth-dev

12-billion parameter model for depth-aware image generation.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/depth-dev
HTTP
Request
(loading)
Response
(loading)

Canny Dev

POST
/v1/flux/canny-dev

Development version using ControlNet for Canny edge detection.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/canny-dev
HTTP
Request
(loading)
Response
(loading)

Redux Dev

POST
/v1/flux/redux-dev

An adapter for the FLUX Dev model that allows for mixing and recreating input images with text prompts. It's particularly useful for image variation and restyling tasks.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/redux-dev
HTTP
Request
(loading)
Response
(loading)

Schnell

POST
/v1/flux/schnell

High-speed model optimized for rapid generation, capable of producing images in 1-4 steps.

Request Body
prompt
stringRequired

Content or scene to create

  • POSThttps://api.opj.app/v1/flux/schnell
HTTP
Request
(loading)
Response
(loading)

Redux Schnell

POST
/v1/flux/redux-schnell

Similar to Redux Dev, but optimized for speed. It allows for quick image variations and restyling using the faster FLUX Schnell base model.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/redux-schnell
HTTP
Request
(loading)
Response
(loading)

Schnell LoRA

POST
/v1/flux/schnell-lora

A version of the FLUX Schnell model that incorporates LoRA technology. This allows for rapid fine-tuning and adaptation of the fast Schnell model to specific styles or use cases while maintaining its speed advantage.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/schnell-lora
HTTP
Request
(loading)
Response
(loading)

Cinema

POST
/v1/flux/cinema

A specialized model designed to generate cinematic-style images with film-like qualities. It's ideal for creating movie-inspired visuals or scenes with a cinematic aesthetic.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/cinema
HTTP
Request
(loading)
Response
(loading)

Ghibsky

POST
/v1/flux/ghibsky

An anime and illustration-style image generation model inspired by Studio Ghibli's distinctive art style. It excels at creating whimsical, fantastical scenes with a characteristic Ghibli-esque charm.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/ghibsky
HTTP
Request
(loading)
Response
(loading)

Hyper

POST
/v1/flux/hyper

A model designed for high-energy, stylized image generation. It's capable of producing vibrant, dynamic visuals with exaggerated features or effects.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/hyper
HTTP
Request
(loading)
Response
(loading)

Formfinder

POST
/v1/flux/formfinder

A model focused on shape and form detection. It's particularly useful for architectural and design applications, helping to identify and generate specific structural forms.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/formfinder
HTTP
Request
(loading)
Response
(loading)

Black Light

POST
/v1/flux/black-light

Fine-tuned model for creating surreal, otherworldly scenes with glowing, neon-like elements.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/flux/black-light
HTTP
Request
(loading)
Response
(loading)

Re-Craftin Models

Generative

POST
/v1/re-craft/generative

Recraft V2 and V3 are AI models designed for versatile image generation. These models offer a range of capabilities, from high-quality professional outputs to anatomically accurate designs, catering to diverse user needs in graphic design and creative projects.

Request Body
prompt
stringRequired

Content or scene to create

model
string

v2 or v3

canvas
stringRequired

Square, Portrait and Landscape

style
string

realistic_image, realistic_image/b_and_w, realistic_image/enterprise, realistic_image/hard_flash, realistic_image/hdr, realistic_image/motion_blur, realistic_image/natural_light, realistic_image/studio_portrait, digital_illustration, digital_illustration/2d_art_poster, digital_illustration/2d_art_poster_2, digital_illustration/3d, digital_illustration/80s, digital_illustration/engraving_color, digital_illustration/glow, digital_illustration/grain, digital_illustration/hand_drawn, digital_illustration/hand_drawn_outline, digital_illustration/handmade_3d, digital_illustration/infantile_sketch, digital_illustration/kawaii, digital_illustration/pixel_art, digital_illustration/psychedelic, digital_illustration/seamless, digital_illustration/voxel and digital_illustration/watercolor

  • POSThttps://api.opj.app/v1/sdxl/generative
HTTP
Request
(loading)
Response
(loading)

SVG Generator

POST
/v1/re-craft/svg

Recraft V3 SVG and Recraft V2 SVG are AI models designed for versatile vector image generation. These models offer a range of capabilities, from high-quality professional SVG outputs to detailed vector graphics, catering to diverse user needs in logo design, icon creation, and scalable illustrations.

Request Body
prompt
stringRequired

Content to create

model
string

v2 or v3

canvas
stringRequired

Square, Portrait and Landscape

style
string

engraving, line_art, line_circuit and linocut

  • POSThttps://api.opj.app/v1/re-craft/svg
HTTP
Request
(loading)
Response
(loading)

SDXLin Models

Generative

POST
/v1/sdxl/generative

SDXL BASE 1.0 is a state-of-the-art text-to-image generation model developed by Stability AI. It features 3.5 billion parameters, dual text encoders for better prompt understanding, and generates images at a native resolution of 1024x1024 pixels. Known for its exceptional visual quality, it excels in photorealism, artistic styles, and handling complex compositions. SDXL also simplifies prompt requirements and supports multi-aspect ratios, making it versatile for various creative applications.

Request Body
prompt
stringRequired

Content or scene to create

model
string

v1 or lightning

canvas
stringRequired

Square, Portrait and Landscape

negative_prompt
string

Elements to avoid in the generated image

guidance
number

Controls how closely the generated image should adhere to the prompt; higher values make the

image more aligned with the prompt

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sdxl/generative
HTTP
Request
(loading)
Response
(loading)

Pony

POST
/v1/sdxl/pony

SDXL Pony is an advanced text-to-image model built on Stable Diffusion XL, adept at creating high-quality images across diverse subjects and styles, including humans, animals, and artistic genres. Trained on 2.6M images, it specializes in both SFW and NSFW outputs with strong natural language understanding, vibrant colors, and detailed compositions, making it ideal for fantasy and anime creators.

Request Body
prompt
stringRequired

Content or scene to create

model
string

pony, ponyai v6 and wai anime sfw

canvas
stringRequired

Square, Portrait and Landscape

scheduler
string

DPM++ 2M SDE Karras, UniPC, Heun, DDIM, DPM2 a, DPM2 a Karras, DPM SDE, DDPM, DPM++ SDE,

DPM++ SDE Karras, LMS, LMS Karras, Euler a, Euler, PNDM, DPM2, DPM2 Karras, DEIS, DPM++ 2M and DPM++ 2M Karras

negative_prompt
string

Elements to avoid in the generated image

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sdxl/pony
HTTP
Request
(loading)
Response
(loading)

Emoji Maker

POST
/v1/sdxl/emoji

Create Custom Emoji Masterpieces: Inspired by Apple's Iconic Style

Request Body
prompt
stringRequired

Emoji to create

  • POSThttps://api.opj.app/v1/sdxl/emoji
HTTP
Request
(loading)
Response
(loading)

SDin Models

3.5 Large Turbo

POST
/v1/sd/3.5/large-turbo

An advanced text-to-image model optimized for fast, high-quality results in 4 inference steps. Using Adversarial Diffusion Distillation (ADD), it delivers detailed, photorealistic images and supports diverse artistic styles. Ideal for applications like digital art, media production, and e-commerce.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sd/3.5/large-turbo
HTTP
Request
(loading)
Response
(loading)

3.5 Large

POST
/v1/sd/3.5/large

An advanced text-to-image model with 8.1B parameters, generating up to 1MP high-quality images. Ideal for digital art, advertising, and VFX, it employs a Multimodal Diffusion Transformer for diverse outputs and exceptional photorealism, useful in media, gaming, and education.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sd/3.5/large
HTTP
Request
(loading)
Response
(loading)

3.5 Medium

POST
/v1/sd/3.5/medium

A text-to-image model optimized for creating high-quality images quickly. Balances speed and detail, supporting diverse styles and uses like design, content creation, and prototyping.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sd/3.5/medium
HTTP
Request
(loading)
Response
(loading)

3.0

POST
/v1/sd/3/generative

This model introduced the Multimodal Diffusion Transformer (MMDiT) architecture, replacing the UNet with a Rectified Flow Transformer. This change significantly enhanced image quality and prompt adherence, offering various model sizes to balance performance and resource efficiency.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sd/3/generative
HTTP
Request
(loading)
Response
(loading)

1.0

POST
/v1/sd/1/generative

This version introduces latent diffusion for text-to-image synthesis, being capable of generating images at 512x512 pixels. It quickly gained popularity for its ability to create detailed and artistic visuals. It is now considered deprecated.

Request Body
prompt
stringRequired

Content or scene to create

canvas
stringRequired

Square, Portrait and Landscape

negative_prompt
string

Elements to avoid in the generated image

guidance
number

Controls how closely the generated image should adhere to the prompt; higher values make the

image more aligned with the prompt

seed
number

Reproducible generation

  • POSThttps://api.opj.app/v1/sd/1/generative
HTTP
Request
(loading)
Response
(loading)

Jobsin Utilities

⭐ Get a Job

GET
/v1/job/{id}

Retrieve a job using its identifier.

URI Parameters
id
stringRequired

Job identifier

  • GEThttps://api.opj.app/v1/job/id
HTTP
Request
(loading)
Response
(loading)

ImageMakerin Utilities

Clarify

POST
/v1/utils/clarify

Image Restoration Algorithm for Blured/Bad images.

Request Body
image
stringRequired

Image to restore (LINK)

type
string

Image Debluring (REDS), Image Denoising and Image Debluring (GoPro)

  • POSThttps://api.opj.app/v1/utils/clarify
HTTP
Request
(loading)
Response
(loading)

Face Restore

POST
/v1/utils/facerestore

Face Restoration Algorithm for Blured/Bad images.

Request Body
image
stringRequired

Face to restore (LINK)

  • POSThttps://api.opj.app/v1/utils/facerestore
HTTP
Request
(loading)
Response
(loading)

Face Swap

POST
/v1/utils/faceswap

Swap faces.

Request Body
source
stringRequired

Image to swap (LINK)

target
stringRequired

Main image (LINK)

  • POSThttps://api.opj.app/v1/utils/faceswap
HTTP
Request
(loading)
Response
(loading)

Prompt Extract

POST
/v1/utils/prompt-extract

Create a prompt based on an image.

Request Body
image
stringRequired

Image (LINK)

  • POSThttps://api.opj.app/v1/utils/prompt-extract
HTTP
Request
(loading)
Response
(loading)

Background Remover

POST
/v1/utils/remove-background

Remove the background of an image.

Request Body
image
stringRequired

Image (LINK)

  • POSThttps://api.opj.app/v1/utils/remove-background
HTTP
Request
(loading)
Response
(loading)

UpScale

POST
/v1/utils/upscale

Image UpScaling Algorithm.

Request Body
image
stringRequired

Image (LINK)

model
string

Openjourney Redefine, EpicRealism Natural, Real-ESRGAN and Animagine Redefine

  • POSThttps://api.opj.app/v1/utils/upscale
HTTP
Request
(loading)
Response
(loading)

Internalin Utilities

License

GET
/v1/internal/license

Get the license information.

  • GEThttps://api.opj.app/v1/internal/license
HTTP
Request
(loading)
Response
(loading)

Ping

GET
/v1/internal/ping

Ping the API & checkpoints.

  • GEThttps://api.opj.app/v1/internal/ping
HTTP
Request
(loading)
Response
(loading)