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

    Type Alias PromptCapabilitiesExperimental

    Prompt capabilities supported by the agent in session/prompt requests.

    Baseline agent functionality requires support for [ContentBlock::Text] and [ContentBlock::ResourceLink] in prompt requests.

    Other variants must be explicitly opted in to. Capabilities for different types of content in prompt requests.

    Indicates which content types beyond the baseline (text and resource links) the agent can process.

    See protocol docs: Prompt Capabilities

    type PromptCapabilities = {
        image?: PromptImageCapabilities | null;
        audio?: PromptAudioCapabilities | null;
        embeddedContext?: PromptEmbeddedContextCapabilities | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    image? audio? embeddedContext? _meta?
    image?: PromptImageCapabilities | null

    Agent supports [ContentBlock::Image].

    Optional. Omitted or null both mean the agent does not advertise support. Supplying {} means the agent supports image content in prompts.

    audio?: PromptAudioCapabilities | null

    Agent supports [ContentBlock::Audio].

    Optional. Omitted or null both mean the agent does not advertise support. Supplying {} means the agent supports audio content in prompts.

    embeddedContext?: PromptEmbeddedContextCapabilities | null

    Agent supports embedded context in session/prompt requests.

    When enabled, the Client is allowed to include [ContentBlock::Resource] in prompt requests for pieces of context that are referenced in the message.

    Optional. Omitted or null both mean the agent does not advertise support. Supplying {} means the agent supports embedded context in prompts.

    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