@adcp/sdk API Reference - v10.0.1
    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_version?: string;
        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_version? adcp_major_version? query uses buyer_brand? countries? brand_id? right_type? include_excluded? pagination? context? ext?

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    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