WIwithchima
Backgrounds

List available backgrounds

Changed on

Returns personal uploads, workspace uploads, and Tella's default image and animated backgrounds in named categories. Each item includes a preview URL and a background value that can be passed directly to the clip update endpoint.

get/v1/backgrounds

Request

Query parameters

scope'personal' | 'workspace' | 'default'

Where the background comes from: the authenticated user's uploads, workspace uploads, or Tella's default catalog

Filter by scope

categoryIdstring

Filter by category ID, such as personal, workspace, default:tella, default:macos, or default:animated

Response

OK

Example response

{
  "categories": [
    {
      "backgrounds": [
        {
          "background": {
            "color": "#000000ff",
            "gradientAngle": 45,
            "gradientColor1": "#ff0080ff",
            "gradientColor2": "#7928caff",
            "shaderGradientPreset": "Halo",
            "sourceId": "su_abc123",
            "type": "solid",
            "videoDurationSeconds": 12.4
          },
          "name": "Red Horizon"
        }
      ],
      "id": "default:tella",
      "name": "Tella"
    }
  ]
}

Changes

  • 12b6eccbb321Revision changes
    • warning

      added the new ambient enum value to the ///////// response property for the response status

    • info

      added the optional property ///////// to the response with the status

  • d0e3293b334eRevision changes
    • warning

      added the new shaderGradient enum value to the ///////// response property for the response status