@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface Provenance

    Provenance metadata for this asset, overrides manifest-level provenance

    interface Provenance {
        digital_source_type?: DigitalSourceType;
        ai_tool?: { name: string; version?: string; provider?: string };
        human_oversight?:
            | "none"
            | "prompt_only"
            | "selected"
            | "edited"
            | "directed";
        declared_by?: {
            agent_url?: string;
            role: "advertiser"
            | "creator"
            | "agency"
            | "platform"
            | "tool";
        };
        declared_at?: string;
        created_time?: string;
        c2pa?: { manifest_url: string };
        disclosure?: {
            required: boolean;
            jurisdictions?: {
                country: string;
                region?: string;
                regulation: string;
                label_text?: string;
                render_guidance?: {
                    persistence?: DisclosurePersistence;
                    min_duration_ms?: number;
                    positions?: DisclosurePosition[];
                    ext?: ExtensionObject;
                };
            }[];
        };
        verification?: {
            verified_by: string;
            verified_time?: string;
            result: "authentic"
            | "ai_generated"
            | "ai_modified"
            | "inconclusive";
            confidence?: number;
            details_url?: string;
        }[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    digital_source_type? ai_tool? human_oversight? declared_by? declared_at? created_time? c2pa? disclosure? verification? ext?

    Properties

    digital_source_type?: DigitalSourceType
    ai_tool?: { name: string; version?: string; provider?: string }

    AI system used to generate or modify this content. Aligns with IPTC 2025.1 AI metadata fields and C2PA claim_generator.

    Type Declaration

    • name: string

      Name of the AI tool or model (e.g., 'DALL-E 3', 'Stable Diffusion XL', 'Gemini')

    • Optionalversion?: string

      Version identifier for the AI tool or model (e.g., '25.1', '0125', '2.1'). For generative models, use the model version rather than the API version.

    • Optionalprovider?: string

      Organization that provides the AI tool (e.g., 'OpenAI', 'Stability AI', 'Google')

    human_oversight?: "none" | "prompt_only" | "selected" | "edited" | "directed"

    Level of human involvement in the AI-assisted creation process

    declared_by?: {
        agent_url?: string;
        role: "advertiser" | "creator" | "agency" | "platform" | "tool";
    }

    Party declaring this provenance. Identifies who attached the provenance claim, enabling receiving parties to assess trust.

    Type Declaration

    • Optionalagent_url?: string

      URL of the agent or service that declared this provenance

    • role: "advertiser" | "creator" | "agency" | "platform" | "tool"

      Role of the declaring party in the supply chain

    declared_at?: string

    When this provenance claim was made (ISO 8601). Distinct from created_time, which records when the content itself was produced. A provenance claim may be attached well after content creation, for example when retroactively declaring AI involvement for regulatory compliance.

    created_time?: string

    When this content was created or generated (ISO 8601)

    c2pa?: { manifest_url: string }

    C2PA Content Credentials reference. Links to the cryptographic provenance manifest for this content. Because file-level C2PA bindings break during ad-tech transcoding, this URL reference preserves the chain of provenance through the supply chain.

    Type Declaration

    • manifest_url: string

      URL to the C2PA manifest store for this content

    disclosure?: {
        required: boolean;
        jurisdictions?: {
            country: string;
            region?: string;
            regulation: string;
            label_text?: string;
            render_guidance?: {
                persistence?: DisclosurePersistence;
                min_duration_ms?: number;
                positions?: DisclosurePosition[];
                ext?: ExtensionObject;
            };
        }[];
    }

    Regulatory disclosure requirements for this content. Indicates whether AI disclosure is required and under which jurisdictions.

    Type Declaration

    • required: boolean

      Whether AI disclosure is required for this content based on applicable regulations

    • Optionaljurisdictions?: {
          country: string;
          region?: string;
          regulation: string;
          label_text?: string;
          render_guidance?: {
              persistence?: DisclosurePersistence;
              min_duration_ms?: number;
              positions?: DisclosurePosition[];
              ext?: ExtensionObject;
          };
      }[]

      Jurisdictions where disclosure obligations apply

    verification?: {
        verified_by: string;
        verified_time?: string;
        result: "authentic" | "ai_generated" | "ai_modified" | "inconclusive";
        confidence?: number;
        details_url?: string;
    }[]

    Third-party verification or detection results for this content. Multiple services may independently evaluate the same content. Provenance is a claim — verification results attached by the declaring party are supplementary. The enforcing party (e.g., seller/publisher) should run its own verification via get_creative_features or calibrate_content.

    Type Declaration

    • verified_by: string

      Name of the verification service (e.g., 'DoubleVerify', 'Hive Moderation', 'Reality Defender')

    • Optionalverified_time?: string

      When the verification was performed (ISO 8601)

    • result: "authentic" | "ai_generated" | "ai_modified" | "inconclusive"

      Verification outcome

    • Optionalconfidence?: number

      Confidence score of the verification result (0.0 to 1.0)

    • Optionaldetails_url?: string

      URL to the full verification report

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties