@adcp/client API Reference - v3.3.3
    Preparing search index...

    Class CreativeAgentClient

    Creative Agent Client - Specialized client for interacting with creative agents

    Creative agents provide creative format catalogs and creative assembly services. This client provides a simplified interface for common creative agent operations.

    // Standard creative agent
    const creativeAgent = new CreativeAgentClient({
      agentUrl: 'https://creative.adcontextprotocol.org/mcp'
    });

    // List available formats
    const formats = await creativeAgent.listFormats();

    // Find specific format
    const banner = formats.find(f => f.format_id.id === 'display_300x250_image');
    Index

    Constructors

    constructor

    Methods

    listFormats findByType findByDimensions findById getAgentUrl getClient

    Constructors

    Methods

    • List all available creative formats

      Parameters

      Returns Promise<CreativeFormat[]>

      Promise resolving to array of creative formats

      const formats = await creativeAgent.listFormats();

      // Filter to display formats
      const displayFormats = formats.filter(f => f.type === 'display');

      // Find by dimensions
      const banners = formats.filter(f =>
        f.renders?.[0]?.dimensions?.width === 300 &&
        f.renders?.[0]?.dimensions?.height === 250
      );

    • Find formats by dimensions

      Parameters

      • width: number

        Width in pixels

      • height: number

        Height in pixels

      Returns Promise<CreativeFormat[]>

      Promise resolving to matching formats

      // Find all 300x250 formats
      const mediumRectangles = await creativeAgent.findByDimensions(300, 250);

    • Find format by ID

      Parameters

      • formatId: string

        Format ID to search for

      Returns Promise<undefined | CreativeFormat>

      Promise resolving to matching format or undefined

      const format = await creativeAgent.findById('display_300x250_image');
      if (format) {
        console.log(`Found: ${format.name}`);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods