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.

Example

// 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 findByDimensions findById listCreatives getAgentUrl getClient

Constructors

constructor

new CreativeAgentClient(config: CreativeAgentClientConfig): CreativeAgentClient
Parameters
- config: CreativeAgentClientConfig
Returns CreativeAgentClient
- Defined in src/lib/core/CreativeAgentClient.ts:52

Methods

listFormats

listFormats(params?: ListCreativeFormatsRequest): Promise<CreativeFormat[]>
List all available creative formats
Parameters
- params: ListCreativeFormatsRequest = {}
  Optional filtering parameters
Returns Promise<CreativeFormat[]>
Promise resolving to array of creative formats
Example
```
const formats = await creativeAgent.listFormats();

// Find by dimensions
const banners = formats.filter(f =>
  f.renders?.[0]?.dimensions?.width === 300 &&
  f.renders?.[0]?.dimensions?.height === 250
);
```
- Defined in src/lib/core/CreativeAgentClient.ts:82

findByDimensions

findByDimensions(width: number, height: number): Promise<CreativeFormat[]>
Find formats by dimensions
Parameters
- width: number
  Width in pixels
- height: number
  Height in pixels
Returns Promise<CreativeFormat[]>
Promise resolving to matching formats
Example
```
// Find all 300x250 formats
const mediumRectangles = await creativeAgent.findByDimensions(300, 250);
```
- Defined in src/lib/core/CreativeAgentClient.ts:109

findById

findById(formatId: string): Promise<CreativeFormat | undefined>
Find format by ID
Parameters
- formatId: string
  Format ID to search for
Returns Promise<CreativeFormat | undefined>
Promise resolving to matching format or undefined
Example
```
const format = await creativeAgent.findById('display_300x250_image');
if (format) {
  console.log(`Found: ${format.name}`);
}
```
- Defined in src/lib/core/CreativeAgentClient.ts:134

listCreatives

listCreatives(
    params?: ListCreativesRequest,
    inputHandler?: InputHandler,
    options?: TaskOptions,
): Promise<ListCreativesResponse>
List creatives in the agent's library
Parameters
- params: ListCreativesRequest = {}
  Optional filtering, sorting, and pagination parameters
- OptionalinputHandler: InputHandler
- Optionaloptions: TaskOptions
Returns Promise<ListCreativesResponse>
Promise resolving to the list creatives response
Example
```
const result = await creativeAgent.listCreatives({
  filters: { statuses: ['approved'], has_variables: true },
  include_variables: true
});
```
- Defined in src/lib/core/CreativeAgentClient.ts:153

getAgentUrl

getAgentUrl(): string
Get the agent URL

Returns string
- Defined in src/lib/core/CreativeAgentClient.ts:170

getClient

getClient(): SingleAgentClient
Get the underlying single-agent client for advanced operations

Returns SingleAgentClient
- Defined in src/lib/core/CreativeAgentClient.ts:177

Class CreativeAgentClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CreativeAgentClient

Methods

listFormats

Parameters

Returns Promise<CreativeFormat[]>

Example

findByDimensions

Parameters

Returns Promise<CreativeFormat[]>

Example

findById

Parameters

Returns Promise<CreativeFormat | undefined>

Example

listCreatives

Parameters

Returns Promise<ListCreativesResponse>

Example

getAgentUrl

Returns string

getClient

Returns SingleAgentClient

Settings

On This Page