---
title: "Generate Skybox"
method: POST
path: "/api/v1/skybox"
tags: ["Skyboxes"]
---

# Generate Skybox

`POST /api/v1/skybox`

## Request

- Base URL: `https://backend.blockadelabs.com`
- URL: `https://backend.blockadelabs.com/api/v1/skybox`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/docs/api/v1/skybox/post.ts> (a function with typed inputs; its response is checked against the schema)

Used for generating skyboxes, skybox remixes and depth maps.

## Headers

- `x-api-key` string

## Request body `multipart/form-data`

- object
  - `prompt` string, required: Text prompt describing the skybox world you wish to create. Maximum number of characters: 550. If you are using skybox_style_id then the maximum number of characters is defined in the max-char response parameter defined for each style.
  - `negative_text` string: Describe things to avoid in the skybox world you wish to create. Maximum number of characters: 200. If you are using skybox_style_id then the maximum number of characters is defined in the negative-text-max-char response parameter defined for each style.
  - `enhance_prompt` boolean: Have an AI automatically improve your prompt to generate pro-level results every time (default: false)
  - `seed` integer: Send 0 for a random seed generation. Any other number (1-2147483647) set will be used to "freeze" the image generator and create similar images when run again with the same seed and settings.
  - `skybox_style_id` integer: Predefined styles that influence the overall aesthetic of your skybox generation (Fantasy landscape, Anime art style, etc...).
  - `remix_imagine_id` integer: ID of a previously generated skybox
  - `control_image` string, binary: Control image used to influence the generation. The image needs to be exacly 1024 pixels wide and 512 pixels tall PNG equirectangular projection image of a scribble with black (#00000) background and white (#ffffff) brush strokes. For "scribble" effect you will also need to send control_model="scribble".
  - `control_model` string: Model used for the control_image. Currently, the only option is: "scribble".
  - `init_image` string, binary: Image (Binary/Base64 string/Absolute URL) to be used as initial image for Skybox generation. Please use equirectangular 360° images. 2:1 aspect ratio recommended. Maximum file size is 50 megabytes.
  - `init_strength` number: Scale to be used as initial influence of the "Init Image" for Skybox generation. The default value is 0, allowed range is between 0 and 0.97, where 0 represents no influence and 0.97 represents lots of influence. Only has an effect when using an init_image parameter.
  - `variant_id` integer: ID of a generation quality variant (from the variants array in the Get Skybox Styles response). Only applicable to Model 4 styles. If omitted the default variant is used.
  - `return_depth_hq` boolean: Request for high quality depth map. It will be returned in the depth_map_url parameter. (default: false)
  - `webhook_url` string: Optionally, you may specify a webhook url to specify the destination for progress updates

## Response `200`

- object
  - `id` integer: ID of your generation. It can be used to track generation progress or to cancel the generation
  - `obfuscated_id` string: Hash id of your generation
  - `user_id` integer: Your user id
  - `title` string: Generation title
  - `prompt` string
  - `seed` integer
  - `negative_text` string
  - `username` string: Your username
  - `status` string: Initially status is set as 'pending' after you send a generation request. Status will change from one state to another and you will get updates for each one if you are using pusher or webhook: pending -> dispatched -> processing -> complete. Also you can get abort or error.
  - `queue_position` integer: Position of your request in a generation queue
  - `file_url` string: Full size of generated image url (empty until generation is completed)
  - `thumb_url` string: Thumbnail of generated image url (empty until generation is completed)
  - `depth_map_url` string
  - `remix_imagine_id` string
  - `remix_obfuscated_id` string
  - `isMyFavorite` boolean
  - `created_at` string: Time created
  - `updated_at` string: Time updated
  - `error_message` string: If status=error here you should see the error message
  - `pusher_channel` string: Pusher channel name used to track generation progress
  - `pusher_event` string: Pusher channel event used to track generation progress
  - `type` string: Type of skybox generation
  - `skybox_style_id` integer: Skybox style id used in a generation request
  - `skybox_id` integer
  - `skybox_style_name` string: Skybox style name used in a generation request
  - `skybox_name` string

---

[API](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation.md) - [All operations](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/revisions/7560ac18c09c?raw)