@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface GetRightsRequest

    Search for licensable rights across a brand agent's roster. Returns matches with pricing. Discovery is natural-language-first — no taxonomy for categories. The agent interprets intent from the query and filters based on the buyer's brand compatibility.

    interface GetRightsRequest {
        adcp_major_version?: number;
        query: string;
        uses: RightUse[];
        buyer_brand?: BrandReference;
        countries?: string[];
        brand_id?: string;
        right_type?: RightType;
        include_excluded?: boolean;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? query uses buyer_brand? countries? brand_id? right_type? include_excluded? pagination? context? ext?

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    query: string

    Natural language description of desired rights. The agent interprets intent, budget signals, and compatibility from this text.

    2000

    uses: RightUse[]

    Rights uses being requested. The agent returns options covering these uses, potentially bundled into composite pricing.

    buyer_brand?: BrandReference
    countries?: string[]

    Countries where rights are needed (ISO 3166-1 alpha-2). Filters to rights available in these markets.

    brand_id?: string

    Search within a specific brand's rights. If omitted, searches across the agent's full roster.

    right_type?: RightType
    include_excluded?: boolean

    Include filtered-out results in the excluded array with reasons. Defaults to false.

    pagination?: PaginationRequest
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties