Create an Image with APITemplate.io API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create an Image with the APITemplate.io API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Create an Image action
1. Connect your APITemplate.io account
2. Optional- Select a API Endpoints
3. Select a Template Id
4. Configure Overrides
5. Optional- Configure Expiration
6. Optional- Configure Meta
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create an Image with APITemplate.io API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + APITemplate.io

Try it

Create an Image with APITemplate.io API on New Item in Feed from RSS API

RSS + APITemplate.io

Try it

Create an Image with APITemplate.io API on New Message in Channel from Discord Bot API

Discord Bot + APITemplate.io

Try it

Create an Image with APITemplate.io API on New Submission from Typeform API

Typeform + APITemplate.io

Try it

Create an Image 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 an Image on APITemplate.io

Description:Create a JPEG file(along with PNG) with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-image) for more information

Version:0.0.1

Key:apitemplate_io-create-image

View on GitHub

Code#

import app from "../../app/apitemplate_io.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create an Image",
    description: "Create a JPEG file(along with PNG) with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-image) for more information",
    key: "apitemplate_io-create-image",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        apiEndpoints: {
            propDefinition: [
                app,
                "apiEndpoints",
            ],
        },
        templateId: {
            propDefinition: [
                app,
                "templateId",
                () => ({
                    format: "JPEG",
                }),
            ],
        },
        overrides: {
            propDefinition: [
                app,
                "overrides",
            ],
        },
        expiration: {
            propDefinition: [
                app,
                "expiration",
            ],
        },
        meta: {
            propDefinition: [
                app,
                "meta",
            ],
        },
    },
    async run({ $ }) {
        const params = {
            template_id: this.templateId,
            expiration: this.expiration,
            meta: this.meta,
        };
        let overrides = this.overrides;
        if (overrides && typeof (this.overrides) === "string") {
            overrides = JSON.parse(this.overrides);
        }
        if (overrides && !Array.isArray(overrides)) {
            throw new ConfigurationError("Override must ba an array of objects with the property name and the replaced values on the template.");
        }
        const data = {
            overrides,
        };
        const response = await this.app.createImage($, this.apiEndpoints, params, data);
        $.export("$summary", `Successfully created a new image: ${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.

Label	Prop	Type	Description
APITemplate.io	`app`	`app`	This component uses the APITemplate.io app.
API Endpoints	`apiEndpoints`	`string`	Select 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 Id	`templateId`	`string`	Select a value from the drop down menu.
Overrides	`overrides`	`any`	Array of objects with the property name and the replaced values on the template, as shown below: `[{"name": "text_name","text": "My Name"}, {"name": "text_quote","text": "Lorem ipsum dolor sit..."}]`
Expiration	`expiration`	`integer`	Expiration of the generated image in minutes(default to `0`, store permanently).
Meta	`meta`	`string`	Specify an external reference ID for your own reference. It appears in the `list-objects` API.

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,