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

    Interface BareFormatIdResolveOptions

    interface BareFormatIdResolveOptions {
        agentUrl?: string;
        assetType?: string;
        assetTypeHint?: string;
    }
    Index

    Properties

    agentUrl?: string

    agent_url to attach when lifting the bare id to a structured V1FormatId for resolution. Defaults to the canonical AAO host (https://creative.adcontextprotocol.org/) — the publisher of every AAO catalog id, and the source of essentially all bare ids persisted before the { agent_url, id } convention. Override only when the bare id was minted under a different agent's catalog — for an AAO catalog id, leave this unset; passing a non-AAO agentUrl won't match the AAO-keyed catalog and resolves to null.

    assetType?: string

    Asset-type disambiguator for an under-specified bare id. The AAO catalog names per-asset-type variants <base>_<suffix> (e.g. display_300x250display_300x250_image / _html / _generative). A size-only bare id like display_300x250 is genuinely ambiguous and resolves to null on its own; pass the asset type you already hold (an adopter's format_type) and the resolver retries the disambiguated catalog variant <id>_<suffix>.

    The vocabulary is the catalog asset type where it differs from the variant suffix (javascript_js), otherwise the suffix itself (image, html, generative, js). Canonical-kind aliases are also accepted (html5html, display_tagjs) for callers already holding a kind-like local value.

    Only consulted when the bare id does NOT resolve on its own (a real catalog id is authoritative). Still fails closed: if <id>_<suffix> is not a catalog entry, returns null — the hint narrows, it never fabricates.

    assetTypeHint?: string

    Use assetType. Kept as a backwards-compatible alias for callers who adopted the initial helper surface before issue #2289.