View as Markdown
Adrapid icon

Adrapid ACTION

Create Banner

Generates a new banner using provided data. This action can create different types of banners, such as animated HTML5, image, or video banners. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Adrapid account once, then configure and run Create Banner from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "adrapid-create-banner",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    adrapid: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Template Id",
    modes: ["Modes"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Banner inputs
Property Type Description
templateId Template Id string
The id of the template to create the banner.
Required Dynamic
modes Modes string[]
Modes for the resulting banners, previously set on configuration block.
Optional
overrides Overrides object
With this parameter we override the default template content. We use the name of the item we want to override, valid properties are text, url (for external images) and css. See the documentation.
Optional
sync Sync boolean
Get banner url in the same response. Delay the response until the banner is ready. Usually in a few seconds with a maxtime of two minutes.
Optional
editable Editable boolean
Make banner editable, creating a template that is a copy of the banner.
Optional
excludeBaseSize Exclude Base Size boolean
Exclude base size from the banner. Only applies to multisize banners.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
adrapid-create-banner
Version
0.0.2
App
Adrapid
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes