---
title: "Get Skybox Style Families"
method: GET
path: "/api/v1/skybox/families"
tags: ["Skyboxes"]
---

# Get Skybox Style Families

`GET /api/v1/skybox/families`

## Request

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

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.

## Headers

- `x-api-key` string

## Response `200`

- object[]
  - `type` string: Can be of type 'family' or 'style' if the style doesn't belong to any families
  - `id` integer: ID of a type
  - `name` string: Name of the menu item
  - `sort_order` integer: Ascending order position in the menu
  - `items` object[]: Collection of styles that belong to a family
    - `type` string: Refers to a skybox style type found within a specific family
    - `id` integer: To be used as 'skybox_style_id' parameter in the 'Generate skybox' endpoint to influence the overall aesthetic of your skybox generation
    - `name` string: Name of the style
    - `sort_order` integer: Ascending order position inside a family
    - `description` string: This is a description of this style (string/nullable)
    - `max-char` integer: Maximum number of characters that can be used for 'prompt' in the 'Generate skybox' endpoint
    - `negative-text-max-char` integer: Maximum number of characters that can be used for 'negative_text' in the 'Generate skybox' endpoint
    - `image` string: Webp image example of the style
    - `image_jpg` string: JPG image example of the style
    - `model` string: Model name
    - `model_version` string: Model version number

---

[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)
