v1

latestOpenAPI 3.0.02026-08-064021.3 KB

Endpoints

Get Template info by ID

Retrieve details for a specific private template by its ID. Please note: This endpoint is for inspecting your private templates only and cannot be used to retrieve details for public template IDs.

get/ads/templates/{template_id}

Path parameters

template_idstring required

The ID of the template.

Headers

api_tokenstring required

API token associated with the organization.

Response

Successfully retrieved template details.

scene_resolutionsobject

A dictionary mapping scene keys (e.g., "scene_1") to their resolution dimensions.

Example response

{
  "scene_1": [
    {
      "id": "6n_yngnjyHm9rbVRyE69z",
      "layer_type": "smartImage",
      "content_type": "smartImage",
      "content": "https://org-assets.bria.ai/...",
      "scene_number": 1
    },
    {
      "id": "mSYZhrISh4EeYRFsvxJQG",
      "layer_type": "text",
      "content_type": "Heading #1",
      "content": "Sale",
      "scene_number": 1
    }
  ],
  "scene_2": [
    {
      "id": "logo_ref_123",
      "layer_type": "logo",
      "content_type": "Logo #1",
      "content": "https://org-assets.bria.ai/logo.png",
      "scene_number": 2
    },
    {
      "id": "shape_ref_456",
      "layer_type": "shape",
      "content_type": "Basic Shape #1",
      "content": "https://org-assets.bria.ai/shape.png",
      "scene_number": 2
    }
  ],
  "scene_resolutions": {
    "scene_1": {
      "width": 1920,
      "height": 1080
    },
    "scene_2": {
      "width": 1080,
      "height": 1080
    }
  }
}