View as Markdown
Intelliprint icon

Intelliprint ACTION

Create a Print Job

Creates a new print job in the Intelliprint API. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Intelliprint account once, then configure and run Create a Print Job 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: "intelliprint-create-a-print-job",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    intelliprint: { authProvisionId: "apn_xxxxxxx" },
    filePath: "File Path",
    reference: "Reference",
  },
})

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 a Print Job inputs
Property Type Description
filePath File Path string
The file to upload. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.txt)
Required
reference Reference string
An user-provided reference for this Print Job.
Optional
confirmed Confirmed boolean
Whether to confirm this Print Job immediately, or to leave it as a draft.
Optional
testmode Test Mode boolean
Whether to mark this Print Job as a test.
Optional
splittingMethod Splitting Method string
The method to use to split the Print Job into multiple Print Jobs.
Optional
splitOnPhrase Split On Phrase string
The word or phrase to split letters using. Only used when Splitting Method is set to split_on_phrase.
Optional
splitOnPage Split On Page integer
The number of pages each letter should be. Only used when Splitting Method is set to split_on_page.
Optional
doubleSided Double Sided string
Whether to print these letters double sided.
Optional
doubleSidedSpecificPages Double Sided Specific Pages string
The array of pages to print double sided. Only used when Double Sided is set to mixed. Example: 1-3,6-7.
Optional
premiumQuality Premium Quality boolean
Whether to print these letters in premium quality.
Optional
postageService Postage Service string
The postage service to use for this Print Job.
Optional
idealEnvelope Ideal Envelope string
The ideal envelope size for these letters.
Optional
mailDate Mail Date string
The date to send this letter out on. Format: YYYY-MM-DD
Optional
backgroundFirstPage Background First Page string
The ID of the Background to apply to the first page of these letters.
Optional
backgroundOtherPages Background Other Pages string
The ID of the Background to apply to the other pages of these letters.
Optional
confidential Confidential boolean
Whether to mark letters of this Print Job as confidential.
Optional
removeLettersWithPhrase Remove Letters With Phrase string
Remove letter objects that have this phrase in their content.
Optional
removeLettersSeries Remove Letters Series string[]
An array of letters' indexes that have been removed.
Optional
nudgeX Nudge X integer
What amount in mm to move the first page of each letter horizontally. A positive number moves the page right, a negative number moves the page left.
Optional
nudgeY Nudge Y integer
What amount in mm to move the first page of each letter vertically. A positive number moves the page down, a negative number moves the page up.
Optional
confirmationEmail Confirmation Email boolean
Whether a confirmation email should be sent to the user or account's email address when this letter is confirmed.
Optional
metadata Metadata object
A key-value object for storing any information you want to along with this Print Job.
Optional
syncDir SyncDir dir
Required

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
intelliprint-create-a-print-job
Version
0.0.2
App
Intelliprint
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes