@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface BuildCreativeSuccess

    Single-format success response. Returned when the request used target_format_id (without fan-out). Carries an optional build_variant_id so a single build is refinable; multi-format builds that need per-output refinable leaves should request the variant shape (max_variants).

    interface BuildCreativeSuccess {
        creative_manifest: CreativeManifest;
        build_variant_id?: string;
        recipe_hash?: string;
        sandbox?: boolean;
        expires_at?: string;
        preview?: {
            previews: {
                preview_id: string;
                renders: PreviewRender[];
                input: {
                    name: string;
                    macros?: { [k: string]: string | undefined };
                    context_description?: string;
                };
            }[];
            interactive_url?: string;
            expires_at: string;
        };
        preview_error?: Error;
        pricing_option_id?: string;
        vendor_cost?: number;
        currency?: string;
        consumption?: CreativeConsumption;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    creative_manifest build_variant_id? recipe_hash? sandbox? expires_at? preview? preview_error? pricing_option_id? vendor_cost? currency? consumption? context? ext?

    Properties

    creative_manifest: CreativeManifest
    build_variant_id?: string

    Leaf handle for this produced creative — present when the agent supports refinement (creative.supports_refinement). Pass it as refine_from_build_variant_id to refine this build. Same namespace as BuildCreativeVariantSuccess leaves; distinct from served variant_id / preview_id. On the canonical promotion path, this value becomes the creative_id when the produced leaf is trafficked or added to the library.

    recipe_hash?: string

    Optional agent-computed, opaque, agent-scoped identity for the build-determining inputs that produced this creative. Stable for identical inputs as defined by the agent, and comparable only within the same agent. ETag-style semantics: the protocol defines the field and contract, not the hash algorithm or canonical input set. Identifies generative-input identity, not output equality, legal/disclosure equivalence, or the build-to-delivery join.

    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    expires_at?: string

    ISO 8601 timestamp when generated asset URLs in the manifest expire. Set to the earliest expiration across all generated assets. Re-build the creative after this time to get fresh URLs.

    date-time

    preview?: {
        previews: {
            preview_id: string;
            renders: PreviewRender[];
            input: {
                name: string;
                macros?: { [k: string]: string | undefined };
                context_description?: string;
            };
        }[];
        interactive_url?: string;
        expires_at: string;
    }

    Preview renders included when the request set include_preview to true and the agent supports it. Contains the same content fields as a preview_creative single response (previews, interactive_url, expires_at) minus the response_type discriminator, so clients can reuse the same preview rendering logic.

    Type Declaration

    • previews: {
          preview_id: string;
          renders: PreviewRender[];
          input: {
              name: string;
              macros?: { [k: string]: string | undefined };
              context_description?: string;
          };
      }[]

      Array of preview variants. Each preview corresponds to an input set from preview_inputs, or a single default preview if no inputs were provided.

    • Optionalinteractive_url?: string

      Optional URL to an interactive testing page that shows all preview variants with controls to switch between them.

    • expires_at: string

      ISO 8601 timestamp when preview URLs expire. May differ from the manifest's expires_at.

      date-time

    preview_error?: Error
    pricing_option_id?: string

    Which rate card pricing option was applied for this build. Present when the creative agent charges for its services. Pass this in report_usage to identify which pricing option was applied.

    vendor_cost?: number

    Cost incurred for this build, denominated in currency. May be 0 for CPM-priced creatives where cost accrues at serve time rather than build time.

    0

    currency?: string

    ISO 4217 currency code for vendor_cost.

    ^[A-Z]{3}$

    consumption?: CreativeConsumption
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties