CONNECT APP
Build with Orshot
Automated Image Generation for Marketing
Marketing
- API key
MCP
Give your agent Orshot tools
Every Orshot action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Orshot account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "orshot",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Generate Image from Library Template:
const result = await mcp.callTool({
name: "orshot-generate-image-library-template",
arguments: {
templateId: "Template ID",
responseType: "Response Type",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "orshot",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Generate Image from Library Template:
result = await session.call_tool("orshot-generate-image-library-template", {
"templateId": "Template ID",
"responseType": "Response Type",
})SDK
Run Orshot actions from your backend
Connect a user's Orshot account once, then run Generate Image from Library Template on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-library-template",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
orshot: { authProvisionId: "apn_xxxxxxx" },
templateId: "Template ID",
responseType: "Response Type",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="orshot-generate-image-library-template",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"orshot": {"authProvisionId": "apn_xxxxxxx"},
"templateId": "Template ID",
"responseType": "Response Type",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "orshot-generate-image-library-template",
"configured_props": {
"orshot": { "authProvisionId": "apn_xxxxxxx" },
"templateId": "Template ID",
"responseType": "Response Type"
}
}'TOOLS
Orshot actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Generate Image from Library Template
actionGenerate an image from a pre-designed library template using the Orshot API. See the documentationWritev0.0.3 -
Generate Image from Studio Template
actionGenerate an image from an Orshot Studio template using the Orshot API. See the documentationWritev0.0.3 -
Get Studio Template Modifications
actionGet available modification keys for a studio templateRead-onlyv0.0.2 -
Get Template Modifications
actionGet available modification keys for a library templateRead-onlyv0.0.2 -
List Templates
actionRetrieve a list of available library templates from Orshot. See templatesRead-onlyv0.0.3
No Orshot triggers are available yet.
- App slug
- orshot
- Authentication
- API key
- Categories
- Marketing
- Actions
- 5
- Triggers
- 0
- API proxy
- Not available