View as Markdown
Orshot icon

Orshot ACTION

Generate Image from Studio Template

Generate an image from an Orshot Studio template using the Orshot API. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Orshot account once, then configure and run Generate Image from Studio Template 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: "orshot-generate-image-studio-template",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orshot: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Studio Template ID",
    responseType: "Response Type",
  },
})

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.

Generate Image from Studio Template inputs
Property Type Description
templateId Studio Template ID string
The ID of the studio template to render. You can find this on the template playground page.
Required
responseType Response Type string
Type of response to return
Required
responseFormat Response Format string
Format of the rendered image
Required
modifications Template Modifications object
Key-value pairs for template modifications. The keys should match the modification keys available for your template.
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
orshot-generate-image-studio-template
Version
0.0.3
App
Orshot
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes