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

    Type Alias IdleStateUpdateExperimental

    The agent is ready to process a new prompt.

    type IdleStateUpdate = {
        stopReason?: StopReason | null;
        usage?: Usage | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    stopReason? usage? _meta?
    stopReason?: StopReason | null

    Indicates why foreground work stopped.

    Optional. Omitted or null both mean the agent is not reporting a stop reason. Agents SHOULD include this when the idle transition ends foreground work.

    usage?: Usage | null

    UNSTABLE

    This capability is not part of the spec yet, and may be removed or changed at any point.

    Token usage for completed foreground work.

    Optional. Omitted or null both mean the agent is not reporting token usage for this state update.

    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