place.stream.branding.getBranding Documentation (EN)

main query

Get all branding configuration for the broadcaster.

Parameters

broadcaster string did Optional

DID of the broadcaster. If not provided, uses the server's default broadcaster.

Output

Encodingapplication/json

assets array Required

List of available branding assets

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

broadcaster DID of the broadcaster. If not provided, uses the server's default broadcaster.

View raw schema

{
  "description": "Get all branding configuration for the broadcaster.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "assets": {
          "description": "List of available branding assets",
          "items": {
            "ref": "#brandingAsset",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "assets"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "broadcaster": {
        "description": "DID of the broadcaster. If not provided, uses the server's default broadcaster.",
        "format": "did",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

brandingAsset object

No description available.

Properties

data string Optional

Inline data for text assets

height integer Optional

Image height in pixels (optional, for images only)

key string Required

Asset key identifier

mimeType string Required

MIME type of the asset

url string Optional

URL to fetch the asset blob (for images)

width integer Optional

Image width in pixels (optional, for images only)

View raw schema

{
  "properties": {
    "data": {
      "description": "Inline data for text assets",
      "type": "string"
    },
    "height": {
      "description": "Image height in pixels (optional, for images only)",
      "type": "integer"
    },
    "key": {
      "description": "Asset key identifier",
      "type": "string"
    },
    "mimeType": {
      "description": "MIME type of the asset",
      "type": "string"
    },
    "url": {
      "description": "URL to fetch the asset blob (for images)",
      "type": "string"
    },
    "width": {
      "description": "Image width in pixels (optional, for images only)",
      "type": "integer"
    }
  },
  "required": [
    "key",
    "mimeType"
  ],
  "type": "object"
}