Skybox Batch Generation

Submit a batch of skybox generations.

post/api/v1/skybox/batch

Request

Base URL
https://backend.blockadelabs.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/docs/api/v1/skybox/batch/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-api-keystring

Request body

promptstring required

Prompt text for the generated skyboxes.

skybox_style_idinteger

Skybox style ID. Defaults to the configured default style when omitted.

quantityinteger required

Number of skyboxes to generate. Must be a positive integer.

variant_idinteger

Required for Model 4 styles. Selects the Standard or Enhanced variant.

webhook_urlstring

Optional webhook URL for batch status updates.

Example request

{
  "prompt": "A futuristic city at sunset",
  "skybox_style_id": 13,
  "quantity": 3,
  "variant_id": 1
}

Response

idinteger

obfuscated_idstring

user_idinteger

statusstring

quantityinteger

successfully_submittedinteger

completedinteger

erroredinteger

pusher_channelstring

pusher_eventstring

webhook_urlstring

Example response

{
  "id": 123,
  "obfuscated_id": "abc123",
  "user_id": 42,
  "status": "pending",
  "quantity": 3,
  "successfully_submitted": 3,
  "completed": 0,
  "errored": 0,
  "pusher_channel": "batch_status_update_abc123",
  "pusher_event": "status_update",
  "webhook_url": null,
  "submission_errors": [],
  "generations": [
    {
      "id": 456,
      "status": "pending"
    }
  ]
}

Changes

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