PDFMonkey
Generate PDF and image documents from PDFMonkey templates, and list, check, download, or delete the documents you generate.
Connectors
Choose the connector that matches your authentication method. The options below use the names shown in StackAI.
PDFMonkey
API Key
PDFMonkey
Connect to PDFMonkey to generate, list, and download PDF documents.
Set up in PDFMonkey
Prepare the PDFMonkey account or service that the workflow will access. Grant access to the required resources and operations.
API Key: Your PDFMonkey secret key, from the API Key page of the PDFMonkey dashboard. It carries the same privileges as your account and has no narrower scope.
Set up in StackAI
Open Settings → Connections, add a connection, and select PDFMonkey.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
API Key
Yes
Your PDFMonkey secret key, from the API Key page of the PDFMonkey dashboard. It carries the same privileges as your account and has no narrower scope. Provider instructions.
Verify the connection
Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.
If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.
Use an action
Add the required PDFMonkey action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
Run the workflow and inspect the action’s output. Check the result before using it in a later step.
Actions
Generate Document
Create a PDF or image from one of your PDFMonkey templates, filled with your data.
Inputs
Template
select (string)
Yes
The template to fill in. Options load from the selected connection.
Data
textarea
No
The values to put into the template, as JSON. The keys must match the fields your template uses.
File Name
string
No
Name for the generated file. Leave empty to use the template's default.
Wait for Completion
boolean
No
Wait until the document is ready and return its download link. Turn off to return right away. Default: true.
Outputs
Document ID
string
ID of the generated document.
Status
string
Generation status.
Download URL
string
Temporary link to the file (about 1 hour).
Preview URL
string
Link to preview the document.
File Name
string
Name of the generated file.
Failure Cause
string
Why generation failed, if it did.
List Templates
List the document templates in your PDFMonkey account.
Inputs
Workspace
select (string)
No
Only list templates from this workspace. Leave empty for all workspaces. Options load from the selected connection.
Show advanced options
boolean
No
Reveal the result cap and start page. Default: false.
Max Results
integer
No
Maximum number of templates to return. Minimum: 1.
Start Page
integer
No
Page to start from, to continue an earlier list. Minimum: 1.
Outputs
Templates
object_array
Templates found.
Next Page
integer
Page to continue from, if more remain.
Truncated
boolean
Whether some templates were left out by the result cap.
Unlisted Workspaces
object_array
Workspaces whose templates were not all listed.
List Documents
Find documents you generated, filtered by template or status.
Inputs
Template
select (string)
No
Only show documents made from this template. Options load from the selected connection.
Status
select (string)
No
Only show documents with this status. Available values: Draft, Pending, Generating, Success, Failure.
Show advanced options
boolean
No
Reveal workspace, updated-since, limit, and start-page fields. Default: false.
Workspace
select (string)
No
Only show documents from this workspace. Options load from the selected connection.
Updated Since
datetime
No
Only show documents changed after this time.
Max Results
integer
No
Maximum number of documents to return. Minimum: 1. Default: 50.
Start Page
integer
No
Page to start from, to continue an earlier list. Minimum: 1.
Outputs
Documents
object_array
Documents found.
Next Page
integer
Page to continue from, if more remain.
Get Document
Check whether a document is ready and get its download link.
Inputs
Document ID
string
Yes
The document to check.
Outputs
Document ID
string
Document ID.
Status
string
Generation status.
Download URL
string
Temporary link to the file.
Preview URL
string
Link to preview the document.
File Name
string
File name.
Template ID
string
Template used.
Template Name
string
Template used.
Failure Cause
string
Why generation failed.
Created At
string
When it was created.
Updated At
string
When it last changed.
Download Document
Save a finished document to StackAI and get a download link you can pass to other steps.
Inputs
Document ID
string
Yes
The document to download.
Outputs
Download URL
string
Link to the stored file.
File Name
string
File name.
Size (bytes)
integer
File size.
Content Type
string
File type.
Delete Document
Permanently delete a generated document.
Inputs
Document ID
string
Yes
The document to delete. This cannot be undone.
Outputs
Document ID
string
The deleted document.
Deleted
boolean
Whether it was deleted.
Important behavior
Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.
The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.
Last updated
Was this helpful?

