View as Markdown
Serenity* AI Hub icon

Serenity* AI Hub ACTION

Execute Agent

Executes an agent by its code with the provided parameters. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Serenity* AI Hub account once, then configure and run Execute Agent 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: "serenity_ai_hub-execute-agent",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    serenity_ai_hub: { authProvisionId: "apn_xxxxxxx" },
    agentCode: "Agent Code",
    message: "Message",
  },
})

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.

Execute Agent inputs
Property Type Description
agentCode Agent Code string
The unique identifier code of the agent
Required Dynamic
message Message string
The message to send to the agent
Required
culture Culture string
Overrides the response language
Optional
chatId Chat ID string
The ID of an existing conversation to continue. Leave empty to start a new conversation
Optional
additionalParameters Additional Parameters string[]
Array of additional parameters with key and value properties, or a JSON string representing that array. Example: [{"key": "param1", "value": "value1"}]
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
serenity_ai_hub-execute-agent
Version
0.0.1
App
Serenity* AI Hub
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes