--- title: Midjourney Text-to-Image url: https://runapi.ai/docs/api/midjourney/text-to-image.md canonical: https://runapi.ai/docs/api/midjourney/text-to-image locale: en --- # Midjourney Text-to-Image ## Overview Use the text to image endpoint with a supported model. Use the returned Task ID to retrieve its state, or provide callback_url for the deliveries documented below. ### Quick start 1. Create an API key and set it as RUNAPI_API_KEY. 2. Choose a supported model and send a POST request whose body matches that model's schema. 3. Store the returned task ID, then poll until a terminal state or handle the callbacks documented below. ## Endpoint POST /api/v1/midjourney/text_to_image Base URL: https://runapi.ai API version: v1 Authentication: Authorization: Bearer YOUR_API_TOKEN ## Supported models Open a model page for current pricing, rate limits, and commercial-usage details. - [midjourney-v8.1](/models/midjourney/v8.1) ## Request schema Fields and allowed values depend on the selected model. When supplied, callback_url receives the Task deliveries documented below. ### midjourney-v8.1 ```json { "callback_url": { "type": "string" }, "enable_prompt_translation": { "default": false, "type": "boolean" }, "include_split_images": { "default": false, "type": "boolean" }, "model": { "type": "string" }, "prompt": { "required": true, "type": "string" } } ``` ## Create acceptance HTTP 202 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" }, "task_replayed": { "type": "boolean" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling processing HTTP 200 - GET /api/v1/midjourney/text_to_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "progress": { "type": "integer" }, "status": { "enum": [ "processing" ], "type": "string" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling completed HTTP 200 - GET /api/v1/midjourney/text_to_image/:id ### Response schema ```json { "properties": { "actions": { "items": { "type": "string" }, "type": "array" }, "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "image_id": { "type": "string" }, "images": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "progress": { "type": "integer" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "images", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "actions": [ "upscale1", "variation1" ], "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "image_id": "midjourney-image-123", "images": [ { "url": "https://cdn.runapi.ai/public/samples/image.jpg" } ], "progress": 100, "status": "completed" } ``` ## Polling failed HTTP 200 - GET /api/v1/midjourney/text_to_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "type": "string" }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": "Task processing failed.", "id": "tsk_reference_demo", "status": "failed" } ``` ## Customer callback: completed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "actions": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "image_id": { "type": "string" }, "images": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "progress": { "type": "integer" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "images" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "actions": [ "upscale1", "variation1" ], "id": "tsk_reference_demo", "image_id": "midjourney-image-123", "images": [ { "url": "https://cdn.runapi.ai/public/samples/image.jpg" } ], "progress": 100, "status": "completed" } ``` ## Customer callback: failed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "error": { "oneOf": [ { "type": "string" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } ] }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "generation_failed", "message": "Task processing failed." }, "id": "tsk_reference_demo", "status": "failed" } ``` ## Errors HTTP 401 - POST /api/v1/midjourney/text_to_image This response has no body. ## Errors HTTP 401 - GET /api/v1/midjourney/text_to_image/:id This response has no body. ## Errors HTTP 400 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "model_must_be_one_of_midjourney-v8_1", "message": "model must be one of: midjourney-v8.1" } } ``` ## Errors HTTP 402 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "insufficient_balance", "message": "Insufficient balance" } } ``` ## Errors HTTP 403 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "api_token_credit_limit_exceeded", "message": "API key credit limit exceeded" } } ``` ## Errors HTTP 409 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "request_conflict", "message": "The request uses features that are not supported for the selected model" } } ``` ## Errors HTTP 429 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "rate_limited", "message": "Rate limit reached. Please retry later." } } ``` ## Errors HTTP 503 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "service_unavailable", "message": "Service under maintenance, please try again later" } } ``` ## Errors HTTP 504 - POST /api/v1/midjourney/text_to_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": { "code": "timeout_error", "message": "The request timed out" } } ``` ## Errors HTTP 404 - GET /api/v1/midjourney/text_to_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "not_found", "message": "Task with id 'tsk_reference_demo' not found" } } ``` ## Generated Code Samples Use cURL directly, or install an SDK for your language. Each sample submits the validated request shown in this reference. ### curl ```curl curl -X POST https://runapi.ai/api/v1/midjourney/text_to_image \ -H 'Authorization: Bearer YOUR_API_TOKEN' \ -H 'Content-Type: application/json' \ -d '{"model":"midjourney-v8.1","prompt":"A cobalt vase on white marble."}' ``` ### javascript #### Install ```bash npm install @runapi.ai/midjourney ``` ```javascript import { MidjourneyClient } from "@runapi.ai/midjourney"; const client = new MidjourneyClient({ apiKey: process.env.RUNAPI_API_KEY }); const task = await client.textToImage.create({ "model": "midjourney-v8.1", "prompt": "A cobalt vase on white marble." }); ``` ### python #### Install ```bash pip install runapi-midjourney ``` ```python import os from runapi.midjourney import MidjourneyClient client = MidjourneyClient(api_key=os.environ["RUNAPI_API_KEY"]) task = client.text_to_image.create( model="midjourney-v8.1", prompt="A cobalt vase on white marble." ) ``` ### go #### Install ```bash go get github.com/runapi-ai/midjourney-sdk/go@latest ``` ```go package main import ( "context" "log" "os" "github.com/runapi-ai/core-sdk/go/option" midjourney "github.com/runapi-ai/midjourney-sdk/go/midjourney" ) func main() { client, err := midjourney.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY"))) if err != nil { log.Fatal(err) } task, err := client.TextToImage.Create(context.Background(), midjourney.TextToImageParams{ Model: midjourney.TextToImageModel("midjourney-v8.1"), Prompt: "A cobalt vase on white marble.", }) if err != nil { log.Fatal(err) } _ = task } ``` ### ruby #### Install ```bash gem install runapi-midjourney ``` ```ruby require "runapi/midjourney" client = RunApi::Midjourney::Client.new(api_key: ENV.fetch("RUNAPI_API_KEY")) task = client.text_to_image.create( model: "midjourney-v8.1", prompt: "A cobalt vase on white marble." ) ``` ### java #### Install ```kotlin implementation("ai.runapi:runapi-midjourney") ``` ```java import ai.runapi.midjourney.MidjourneyClient; import ai.runapi.midjourney.types.TextToImageParams; import ai.runapi.core.polling.TaskCreateResponse; public final class Example { public static void main(String[] args) { MidjourneyClient client = MidjourneyClient.builder() .apiKey(System.getenv("RUNAPI_API_KEY")) .build(); TaskCreateResponse task = client.textToImage().create( TextToImageParams.builder() .model("midjourney-v8.1") .prompt("A cobalt vase on white marble.") .build() ); } } ``` ### php #### Install ```bash composer require runapi-ai/midjourney ``` ```php textToImage->create([ "model" => "midjourney-v8.1", "prompt" => "A cobalt vase on white marble." ]); ``` ## Related Guides - [Authentication](/docs/guides/authentication) - [Quickstart](/docs/guides/task-api/quickstart)