ACP v2 TypeScript SDK — EXPERIMENTAL DRAFT - v1.3.0
    Preparing search index...

    Type Alias RequestPermissionRequestExperimental

    Request for user permission to proceed with an operation.

    Sent when the agent needs authorization before performing a sensitive operation.

    See protocol docs: Requesting Permission

    type RequestPermissionRequest = {
        sessionId: SessionId;
        title: string;
        description?: string | null;
        subject?: RequestPermissionSubject | null;
        options: PermissionOption[];
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    sessionId title description? subject? options _meta?
    sessionId: SessionId

    The session ID for this request.

    title: string

    Human-readable title for the permission prompt.

    This title is specific to the permission prompt and does not update any subject's displayed title.

    description?: string | null

    Optional human-readable explanation of why permission is needed.

    This text is specific to the permission prompt and does not update any subject's displayed content. Omitted or null both mean no separate permission description was provided.

    subject?: RequestPermissionSubject | null

    Optional structured context about the operation requiring permission.

    Omitted or null both mean no structured subject was provided.

    options: PermissionOption[]

    Available permission options for the user to choose from. Must contain at least one option.

    Optional_meta

    _meta?: { [key: string]: unknown } | null

    The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    Settings
    Member Visibility

    On This Page
    Properties