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

    Type Alias PromptRequest

    Request parameters for sending a user prompt to the agent.

    Contains the user's message and any additional context.

    See protocol docs: User Message

    type PromptRequest = {
        _meta?: { [key: string]: unknown } | null;
        messageId?: string | null;
        prompt: ContentBlock[];
        sessionId: SessionId;
    }
    Index

    Properties

    _meta? messageId? prompt sessionId

    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

    messageId?: string | null

    UNSTABLE

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

    A client-generated unique identifier for this user message.

    If provided, the Agent SHOULD echo this value as userMessageId in the [PromptResponse] to confirm it was recorded. Both clients and agents MUST use UUID format for message IDs.

    prompt: ContentBlock[]

    The blocks of content that compose the user's message.

    As a baseline, the Agent MUST support [ContentBlock::Text] and [ContentBlock::ResourceLink], while other variants are optionally enabled via [PromptCapabilities].

    The Client MUST adapt its interface according to [PromptCapabilities].

    The client MAY include referenced pieces of context as either [ContentBlock::Resource] or [ContentBlock::ResourceLink].

    When available, [ContentBlock::Resource] is preferred as it avoids extra round-trips and allows the message to include pieces of context from sources the agent may not have access to.

    sessionId: SessionId

    The ID of the session to send this user message to

    Settings

    Member Visibility

    On This Page

    Properties