Agent Client Protocol - v0.18.2
    Preparing search index...

    Type Alias PromptResponse

    Response from processing a user prompt.

    See protocol docs: Check for Completion

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

    Properties

    _meta? stopReason usage? userMessageId?

    Properties

    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

    stopReason: StopReason

    Indicates why the agent stopped processing the turn.

    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 this turn (optional).

    userMessageId?: string | null

    UNSTABLE

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

    The acknowledged user message ID.

    If the client provided a messageId in the [PromptRequest], the agent echoes it here to confirm it was recorded. If the client did not provide one, the agent MAY assign one and return it here. Absence of this field indicates the agent did not record a message ID.

    Settings

    Member Visibility

    On This Page

    Properties