BLblockadelabs
Skyboxes

Generate Skybox

Used for generating skyboxes, skybox remixes and depth maps.

post/api/v1/skybox

Request

Headers

x-api-keystring

Request body multipart/form-data

promptstring 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_textstring

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_promptboolean

Have an AI automatically improve your prompt to generate pro-level results every time (default: false)

seedinteger

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_idinteger

Predefined styles that influence the overall aesthetic of your skybox generation (Fantasy landscape, Anime art style, etc...).

remix_imagine_idinteger

ID of a previously generated skybox

control_imagestring 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_modelstring

Model used for the control_image. Currently, the only option is: "scribble".

init_imagestring 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_strengthnumber

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_idinteger

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_hqboolean

Request for high quality depth map. It will be returned in the depth_map_url parameter. (default: false)

webhook_urlstring

Optionally, you may specify a webhook url to specify the destination for progress updates

Example request

{
  "prompt": "dark forest"
}

Response

idinteger

ID of your generation. It can be used to track generation progress or to cancel the generation

obfuscated_idstring

Hash id of your generation

user_idinteger

Your user id

titlestring

Generation title

promptstring
seedinteger
negative_textstring
usernamestring

Your username

statusstring

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_positioninteger

Position of your request in a generation queue

file_urlstring

Full size of generated image url (empty until generation is completed)

thumb_urlstring

Thumbnail of generated image url (empty until generation is completed)

depth_map_urlstring
remix_imagine_idstring
remix_obfuscated_idstring
isMyFavoriteboolean
created_atstring

Time created

updated_atstring

Time updated

error_messagestring

If status=error here you should see the error message

pusher_channelstring

Pusher channel name used to track generation progress

pusher_eventstring

Pusher channel event used to track generation progress

typestring

Type of skybox generation

skybox_style_idinteger

Skybox style id used in a generation request

skybox_idinteger
skybox_style_namestring

Skybox style name used in a generation request

skybox_namestring

Example response

{
  "id": 46,
  "obfuscated_id": "c60354672339614111cee85d21253244",
  "user_id": 8,
  "title": "World #46",
  "prompt": "dark forest",
  "seed": 50702979,
  "negative_text": null,
  "username": "test",
  "status": "pending",
  "queue_position": 1,
  "file_url": "",
  "thumb_url": "",
  "depth_map_url": "",
  "remix_imagine_id": null,
  "remix_obfuscated_id": null,
  "isMyFavorite": false,
  "created_at": "2023-08-21T13:35:14+00:00",
  "updated_at": "2023-08-21T13:35:14+00:00",
  "error_message": null,
  "pusher_channel": "status_update_c60354672339614111cee85d21253244",
  "pusher_event": "status_update",
  "type": "skybox",
  "skybox_style_id": 2,
  "skybox_id": 2,
  "skybox_style_name": "V2 Fantasy Lands",
  "skybox_name": "V2 Fantasy Lands"
}

Changes

No recorded changes to this operation across all 1 revision of this API.