Skyboxes

Get Skybox Style Families

Returns the list of predefined styles that can influence the overall aesthetic of your skybox generation, sorted by style family. This route can be used in order to build a menu of styles sorted by family.

get/api/v1/skybox/families

Request

Headers

x-api-keystring

Response

typestring

Can be of type 'family' or 'style' if the style doesn't belong to any families

idinteger

ID of a type

namestring

Name of the menu item

sort_orderinteger

Ascending order position in the menu

Example response

[
  {
    "type": "family",
    "id": 17,
    "name": "Model 3 Realistic",
    "sort_order": 1,
    "items": [
      {
        "type": "style",
        "id": 119,
        "name": "M3 Photoreal (Featured)",
        "sort_order": 1,
        "description": "Photographic realism with a high degree of flexibility and good visual fidelity",
        "max-char": 600,
        "negative-text-max-char": 410,
        "image": "https://images.blockadelabs.com/images/skybox/WJgTolgUIXCDZM5LOTeUR2T8IOfZHnq2OQzozqH0.webp",
        "image_jpg": "https://images.blockadelabs.com/images/skybox/WJgTolgUIXCDZM5LOTeUR2T8IOfZHnq2OQzozqH0.jpg",
        "model": "Model 3",
        "model_version": "3"
      },
      {
        "type": "style",
        "id": 102,
        "name": "M3 Cinematic Realism",
        "sort_order": 2,
        "description": "Photographic realism with dramatic, dark color grading and filmic mood",
        "max-char": 600,
        "negative-text-max-char": 430,
        "image": "https://images.blockadelabs.com/images/skybox/gGfOHzfOiAgvkVxHVtg6TDNwWa22SvTluHoRJNTK.webp",
        "image_jpg": "https://images.blockadelabs.com/images/skybox/gGfOHzfOiAgvkVxHVtg6TDNwWa22SvTluHoRJNTK.jpg",
        "model": "Model 3",
        "model_version": "3"
      }
    ]
  },
  {
    "type": "style",
    "id": 13,
    "name": "Advanced (no style)",
    "sort_order": 17,
    "description": null,
    "max-char": 540,
    "negative-text-max-char": 220,
    "image": null,
    "image_jpg": null,
    "model": "Model 2",
    "model_version": "2"
  }
]

Changes

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