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

    Interface AdcpErrorInfo

    Structured AdCP error information extracted from a failed task response. Present on TaskResult.adcpError when the agent returns a recognized error.

    interface AdcpErrorInfo {
        code: string;
        message: string;
        recovery?: "transient" | "correctable" | "terminal";
        field?: string;
        suggestion?: string;
        retry_after?: number;
        retryAfterMs?: number;
        details?: Record<string, unknown>;
        issues?: AdcpValidationIssue[];
        synthetic?: boolean;
    }
    Index

    Properties

    code: string

    AdCP error code (e.g., 'RATE_LIMITED', 'PRODUCT_NOT_FOUND')

    message: string

    Human-readable error message. Sellers: do not embed tokens, account IDs, or internal paths — this field is forwarded to ComplianceResult.failures[].adcp_error and is grader-visible beyond the request lifetime.

    recovery?: "transient" | "correctable" | "terminal"

    Recovery classification: retry, fix the request, or give up

    field?: string

    Field that caused the error

    suggestion?: string

    Suggested fix from the agent. Untrusted — sanitize before rendering in HTML.

    retry_after?: number

    Seconds to wait before retrying (transient errors). See also retryAfterMs.

    retryAfterMs?: number

    Milliseconds to wait before retrying — convenience conversion of retry_after * 1000.

    details?: Record<string, unknown>

    Additional error details. Untrusted agent-controlled content — sanitize before rendering. Sellers: do not embed tokens, account IDs, or internal paths — this field is forwarded to ComplianceResult.failures[].adcp_error and is grader-visible beyond the request lifetime.

    Structured validation failures. Present on VALIDATION_ERROR when the seller identifies multiple offending fields. Each item's pointer is RFC 6901 format (e.g. /packages/0/targeting) — differs from the top-level field which uses JSONPath-lite. For LLM self-correction, read keyword first: 'required' → add the field, 'enum' → pick a valid value, 'type' → fix the value type.

    synthetic?: boolean

    True when the SDK inferred this error from unstructured text (L1 compliance)