Create Document with Docupilot API on New File Created from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Docupilot, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

Next, do this

Create Document with the Docupilot 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#

This integration creates a workflow with a OpenAI (ChatGPT) trigger and Docupilot action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New File Created trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Optional- Select a Purpose
Configure the Create Document action
1. Connect your Docupilot account
2. Configure Template URL
3. Configure Template Tokens
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New File Created on OpenAI (ChatGPT)

Description:Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)

Version:0.0.10

Key:openai-new-file-created

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-file-created",
  name: "New File Created",
  description: "Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)",
  version: "0.0.10",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    purpose: {
      propDefinition: [
        common.props.openai,
        "purpose",
      ],
      description: "If specified, events will only be emitted for files with the specified purpose.",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getData() {
      return this.openai.listFiles({
        purpose: this.purpose,
      });
    },
    getMeta(item) {
      return {
        id: item.id,
        summary: `New File: ${item.filename}`,
        ts: item.created_at * 1000,
      };
    },
  },
  sampleEmit,
};

Trigger 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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Purpose	`purpose`	`string`	Select a value from the drop down menu:`fine-tuneassistantsvisionbatch`

Trigger Authentication#

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

About 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 models like ChatGPT, DALL-E, and Whisper.

Action#

Create Document on Docupilot

Description:Create a document [See docs here](https://help.docupilot.app/create-document/api-and-webhook-integration#api-integration)

Version:0.0.1

Key:docupilot-create-document

View on GitHub

Docupilot Overview#

Docupilot offers powerful document automation capabilities, allowing you to create dynamic documents based on templates and data inputs. With the Docupilot API, you can integrate this functionality directly into Pipedream workflows, triggering document generation from a myriad of events and data sources. Think of automating contract creation when a new deal is won in your CRM, or sending personalized letters en masse with the click of a button. The API empowers you to craft, distribute, and manage documents efficiently and programmatically.

Action Code#

import docupilot from "../../app/docupilot.app.mjs";
import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
export default defineAction({
    name: "Create Document",
    description: "Create a document [See docs here](https://help.docupilot.app/create-document/api-and-webhook-integration#api-integration)",
    key: "docupilot-create-document",
    version: "0.0.1",
    type: "action",
    props: {
        docupilot,
        templateUrl: {
            type: "string",
            label: "Template URL",
            description: `Choose a template in the Docupilot dashboard, and go to the **Create** tab, then to **API integrations**.
        \\
        Copy the ***POST Merge URL*** here. Example: \`https://api.docupilot.app/documents/create/46ac75c3/5e7d03ec\``,
        },
        tokens: {
            type: "object",
            label: "Template Tokens",
            description: `The tokens used in this template (as object keys) and their values.
       \\
       Objects and arrays should be in JSON-stringified format.
       \\
       If you need to include characters such as \`{}[]\` in a value, and it should not be parsed as an object or array, prefix the key with \`$\`.`,
        },
    },
    async run({ $ }) {
        const url = this.templateUrl.trim();
        const baseUrl = this.docupilot._createDocumentBaseUrl();
        if (!url.startsWith(baseUrl)) {
            throw new ConfigurationError("Invalid `Template URL`. Check the prop and make sure you copied the URL properly.");
        }
        const data = {};
        const tokens = this.tokens;
        if (tokens) {
            Object.entries(tokens).forEach(([key, value,]) => {
                try {
                    if (!key.startsWith("$") && value.match(/({[^}]*})|(\[[^\]]*\])/)) {
                        value = JSON.parse(value);
                    }
                }
                catch (err) {
                    throw new ConfigurationError(`Error parsing JSON value for key \`${key}\`: *"${err}"*
            \\
            If this is not a JSON string for an object or array, prefix the key with \`$\` as in \`$${key}\``);
                }
                data[key.startsWith("$")
                    ? key.slice(1)
                    : key] = value;
            });
        }
        const params = {
            $,
            url,
            data,
        };
        const response = await this.docupilot.createDocument(params);
        $.export("$summary", "Created document successfully");
        return response;
    },
});

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Docupilot	`docupilot`	`app`	This component uses the Docupilot app.
Template URL	`templateUrl`	`string`	Choose a template in the Docupilot dashboard, and go to the Create tab, then to API integrations. Copy the POST Merge URL here. Example: `https://api.docupilot.app/documents/create/46ac75c3/5e7d03ec`
Template Tokens	`tokens`	`object`	The tokens used in this template (as object keys) and their values. Objects and arrays should be in JSON-stringified format. If you need to include characters such as `{}[]` in a value, and it should not be parsed as an object or array, prefix the key with `$`.