View as Markdown
CraftMyPDF icon

CraftMyPDF ACTION

Create Editor Session

Create a new PDF editor session. The PDF editor url can be embedded into an IFrame. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CraftMyPDF account once, then configure and run Create Editor Session 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: "craftmypdf-create-editor-session",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    craftmypdf: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Template Id",
    expiration: 10,
  },
})

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 Editor Session inputs
Property Type Description
templateId Template Id string
The Id of the template.
Required Dynamic
expiration Expiration (in minutes) integer
Expiration of the generated PDF in minutes. Default to 5 minutes. Range between 1 minute and 24 hours.
Required
canSave Can Save boolean
Can save the template. Default to true.
Optional
canCreatePDF Can Create PDF boolean
Can Generate PDF. Default to true.
Optional
canViewSettings Can View Settings boolean
Can view settings. Default to true.
Optional
canPreview Can Preview boolean
Can preview. Default to true.
Optional
canEditJSON Can Edit JSON boolean
Can edit JSON. Default to true.
Optional
canShowHeader Can Show Header boolean
Show CraftMyPDF header. Default to true.
Optional
canShowLayers Can Show Layers boolean
Show layer dialogue. Default to true.
Optional
canShowPropertyPanel Can Show Property Panel boolean
Show property panel. Default to true.
Optional
canShowHelp Can Show Help boolean
Show Help tab. Default to true.
Optional
canShowData Can Show Data boolean
Show Data tab. Default to true.
Optional
canShowExpressionDoc Can Show Expression Doc boolean
Show Expression Doc tab. Default to true.
Optional
canShowPropertyBinding Can Show Property Binding boolean
Show Property Bind tab for element. Default to true.
Optional
canShowBackURL Can Show Back URL boolean
Show BackURL button. Default to true.
Optional
jsonMode JSON Mode integer
JSON editor - 1, JSON viewer - 2.
Optional
backURL Back URL string
The URL for the back button
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
craftmypdf-create-editor-session
Version
0.0.3
App
CraftMyPDF
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes