← APITemplate.io

Create a PDF with APITemplate.io API

Pipedream makes it easy to connect APIs for APITemplate.io and 1,600+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create a PDF with the APITemplate.io API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 750,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create a PDF with the APITemplate.io API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create a PDF action
    1. Connect your APITemplate.io account
    2. Optional- Select a API Endpoints
    3. Select a Template Id
    4. Configure Data
    5. Optional- Configure Expiration
    6. Optional- Configure Meta
    7. Optional- Select a Export Type
    8. Optional- Configure Output HTML
    9. Optional- Select a Output Format
    10. Optional- Configure Filename
    11. Optional- Configure Image Resample Res
    12. Optional- Configure Is CMYK
    13. Optional- Configure Async
    14. Optional- Configure Webhook URL
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create a PDF with APITemplate.io API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + APITemplate.io
 
Try it
Create a PDF with APITemplate.io API on New Item in Feed from RSS API
RSS + APITemplate.io
 
Try it
Create a PDF with APITemplate.io API on New Message in Channel from Discord Bot API
Discord Bot + APITemplate.io
 
Try it
Create a PDF with APITemplate.io API on New Submission from Typeform API
Typeform + APITemplate.io
 
Try it
Create a PDF with APITemplate.io API on Custom Events from Zoom API
Zoom + APITemplate.io
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create a PDF on APITemplate.io
Description:Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information
Version:0.0.1
Key:apitemplate_io-create-pdf

Code

import app from "../../app/apitemplate_io.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create a PDF",
    description: "Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information",
    key: "apitemplate_io-create-pdf",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        apiEndpoints: {
            propDefinition: [
                app,
                "apiEndpoints",
            ],
        },
        templateId: {
            propDefinition: [
                app,
                "templateId",
                () => ({
                    format: "PDF",
                }),
            ],
        },
        data: {
            propDefinition: [
                app,
                "data",
            ],
        },
        expiration: {
            propDefinition: [
                app,
                "expiration",
            ],
        },
        meta: {
            propDefinition: [
                app,
                "meta",
            ],
        },
        exportType: {
            propDefinition: [
                app,
                "exportType",
            ],
        },
        outputHtml: {
            propDefinition: [
                app,
                "outputHtml",
            ],
        },
        outputFormat: {
            propDefinition: [
                app,
                "outputFormat",
            ],
        },
        filename: {
            propDefinition: [
                app,
                "filename",
            ],
        },
        imageResampleRes: {
            propDefinition: [
                app,
                "imageResampleRes",
            ],
        },
        isCmyk: {
            propDefinition: [
                app,
                "isCmyk",
            ],
        },
        async: {
            propDefinition: [
                app,
                "async",
            ],
        },
        webhookUrl: {
            propDefinition: [
                app,
                "webhookUrl",
            ],
        },
    },
    methods: {
        boolToInt(prop) {
            if (typeof (prop) === "boolean") {
                if (prop) {
                    return 1;
                }
                return 0;
            }
            return prop;
        },
    },
    async run({ $ }) {
        const params = {
            template_id: this.templateId,
            expiration: this.expiration,
            meta: this.meta,
            export_type: this.exportType,
            output_html: this.boolToInt(this.outputHtml),
            output_format: this.outputFormat,
            filename: this.filename,
            image_resample_res: this.imageResampleRes,
            is_cmyk: this.boolToInt(this.isCmyk),
            async: this.boolToInt(this.async),
            webhook_url: this.webhookUrl,
        };
        const response = await this.app.createImage($, this.apiEndpoints, params, this.data);
        $.export("$summary", `Successfully created a new PDF: ${response.transaction_ref}`);
        return response;
    },
});

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
APITemplate.ioappappThis component uses the APITemplate.io app.
API EndpointsapiEndpointsstringSelect a value from the drop down menu:{ "label": "Default (Singapore)", "value": "https://rest.apitemplate.io" }{ "label": "Europe (Frankfurt)", "value": "https://rest-de.apitemplate.io" }{ "label": "US East (N. Virginia)", "value": "https://rest-us.apitemplate.io" }{ "label": "Australia (Sydney)", "value": "https://rest-au.apitemplate.io" }{ "label": "Alternative Default (Singapore)", "value": "https://rest-alt.apitemplate.io" }{ "label": "Alternative Europe (Frankfurt)", "value": "https://rest-alt-de.apitemplate.io" }{ "label": "Alternative US East (N. Virginia)", "value": "https://rest-alt-us.apitemplate.io" }
Template IdtemplateIdstringSelect a value from the drop down menu.
Datadataany

Object to replace values on the template, you can check here for the JSON example for your template.

Expirationexpirationinteger

Expiration of the generated image in minutes(default to 0, store permanently).

Metametastring

Specify an external reference ID for your own reference. It appears in the list-objects API.

Export TypeexportTypestringSelect a value from the drop down menu:jsonfile
Output HTMLoutputHtmlboolean

Whether it should output html or not

Output FormatoutputFormatstringSelect a value from the drop down menu:pdfhtml
Filenamefilenamestring

Default to UUID (e.g 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Use this to specify custom file name, it should end with .pdf

Image Resample ResimageResampleResinteger

We embed the original images by default, meaning large PDF file sizes. Specifying this option helps reduce the PDF file size. Common values are 72, 96, 150, 300 and 600.

Is CMYKisCmykboolean

Use CMYK color profile, Default to false

Asyncasyncboolean

To generate PDF asynchronously, set the value to true and the API call returns immediately. Once the PDF document is generated, we will make a HTTP/HTTPS GET to your webhook and will retry for 3 times before giving up.

Webhook URLwebhookUrlstring

It is the URL of your webhook URL, it starts with http:// or https:// and has to be urlencoded.

Authentication

APITemplate.io uses API keys for authentication. When you connect your APITemplate.io account, Pipedream securely stores the keys so you can easily authenticate to APITemplate.io APIs in both code and no-code steps.

To retrieve your API key,

  • Navigate to your API Template account and sign in
  • Go to “API Integration”

About APITemplate.io

APITemplate.io allows you to auto-generate images and PDF documents with a simple API

More Ways to Use APITemplate.io

Actions

Account Information with the APITemplate.io API

Retrieves information about your account. See the docs for more information

 
Try it
Create an Image with the APITemplate.io API

Create a JPEG file(along with PNG) with JSON data and your template. See the docs for more information

 
Try it
Delete an Object with the APITemplate.io API

Delete a PDF or an image from CDN and mark the transaction as deleted. See the docs for more information

 
Try it
List Generated Objects with the APITemplate.io API

Retrieves all the generated PDFs and images. See the docs for more information

 
Try it

Explore Other Apps

1
-
12
of
1,600+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Beta
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.