get_asset_builder_templates

imerit_ango.sdk.SDK.

get_asset_builder_templates(project_id)

Returns all of the asset builder templates in the provided project.

This operation can also be accomplished using the get_project function and then by accessing the project's assetBuilderTemplates field. This method is provided for convenience.

Parameters

  • project_id: string

Returns

  • output: List[AssetBuilderTemplate] where AssetBuilderTemplate is an object with the following properties:

    • _id str

      • Unique identifier of the template.

    • name: str

      • Unique name for this template.

    • template: str

      • Template HTML that will be filled in while uploading via asset builder.

    • external_id_column: str

      • Column name from the input tabular data to be used as the asset's externalId. In each row, the value in the cell corresponding to this column will be used as the externalId for that row.

    • data_config: Dict[str, DataConfigItem]

      Dictionary mapping column names to their configuration. Each DataConfigItem contains:

      • type: str - The data type for this column. Must be one of: text, link , image , audio , video , iframe , pdf

      • storage: str - Storage configuration for this column. Only necessary when type is one of: video, img, audio, or pdf

      • include_in_export: str (optional, default: False) - Whether to include this column in exports

    • description (Optional): str

      • A description for what the template does or what it is.

    • batch_column (Optional): str

      • Batch column name from the input tabular data to be used as the batch name for that asset. In each row, the value in the cell corresponding to this column will be used as the batch name for that row.

    • pre_label_config (Optional): PreLabelConfig

      Dictionary containing pre-labeling configuration. Each item contains:

      • cla: PreLabelCla - Classification configuration with fields:

        • schemaId: str - Schema identifier

        • title: str - Display title

        • multiple: bool - Whether multiple selections are allowed

      • value: str - Column that will be used as the source of pre-label data

Example

from imerit_ango.sdk import SDK
from imerit_ango.models import AssetBuilderTemplate
sdk = SDK("<YOUR_API_KEY")
project_id = "<YOUR_PROJECT_ID>"

result: AssetBuilderTemplate[] = sdk.get_asset_builder_templates(project_id)

Last updated