Send Message with CustomGPT API

Pipedream makes it easy to connect APIs for CustomGPT and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send Message with the CustomGPT 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 Send Message with the CustomGPT API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Send Message action
1. Connect your CustomGPT account
2. Select a Project ID
3. Select a Conversation ID
4. Optional- Configure External ID
5. Configure Prompt
6. Optional- Configure Custom Persona
7. Select a Chatbot Model
8. Select a Response Source
9. Optional- Configure Custom Content
10. Optional- Configure File Path
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

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.

Send Message on CustomGPT

Description:Sends a message to an existing conversation within a project. [See the documentation](https://docs.customgpt.ai/reference/post_api-v1-projects-projectid-conversations-sessionid-messages)

Version:0.0.1

Key:customgpt-send-message

View on GitHub

Code#

import { getFileStreamAndMetadata } from "@pipedream/platform";
import FormData from "form-data";
import {
  CHATBOT_MODEL_OPTIONS,
  RESPONSE_SOURCE_OPTIONS,
} from "../../common/constants.mjs";
import customgpt from "../../customgpt.app.mjs";

export default {
  key: "customgpt-send-message",
  name: "Send Message",
  description: "Sends a message to an existing conversation within a project. [See the documentation](https://docs.customgpt.ai/reference/post_api-v1-projects-projectid-conversations-sessionid-messages)",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    customgpt,
    projectId: {
      propDefinition: [
        customgpt,
        "projectId",
      ],
    },
    conversationId: {
      propDefinition: [
        customgpt,
        "conversationId",
        ({ projectId }) => ({
          projectId,
          fieldId: "session_id",
        }),
      ],
    },
    externalId: {
      type: "string",
      label: "External ID",
      description: "The external ID of the message",
      optional: true,
    },
    prompt: {
      type: "string",
      label: "Prompt",
      description: "Prompt to send to OpenAI",
    },
    customPersona: {
      type: "string",
      label: "Custom Persona",
      description: "Custom persona to use for the conversation",
      optional: true,
    },
    chatbotModel: {
      type: "string",
      label: "Chatbot Model",
      description: "The model to use for the conversation",
      options: CHATBOT_MODEL_OPTIONS,
    },
    responseSource: {
      type: "string",
      label: "Response Source",
      description: "By default, CustomGPT asks ChatGPT to use only your content in its response (recommended). If you wish ChatGPT to improvise and use its own knowledgebase as well, you can set this to \"openai_content\".",
      options: RESPONSE_SOURCE_OPTIONS,
    },
    customContent: {
      type: "string",
      label: "Custom Content",
      description: "Custom content to use for the conversation",
      optional: true,
    },
    file: {
      type: "string",
      label: "File Path",
      description: "The path to the file saved to the `/tmp` directory (e.g. `tmp/example.pdf`). Allowed types: **pdf, docx, doc, odt, txt, jpg, jpeg, png, webp**. [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = new FormData();
    if (this.prompt) data.append("prompt", this.prompt);
    if (this.customPersona) data.append("custom_persona", this.customPersona);
    data.append("chatbot_model", this.chatbotModel);
    data.append("response_source", this.responseSource);
    if (this.customContent) data.append("custom_content", this.customContent);

    if (this.file) {
      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(this.file);
      data.append("file", stream, {
        filename: metadata.name,
        contentType: metadata.contentType,
      });
    }
    const response = await this.customgpt.sendMessage({
      $,
      conversationId: this.conversationId,
      projectId: this.projectId,
      data,
      headers: data.getHeaders(),
      params: {
        external_id: this.externalId,
      },
    });

    $.export("$summary", `Successfully sent message to conversation ${this.conversationId}`);

    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
CustomGPT	`customgpt`	`app`	This component uses the CustomGPT app.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Conversation ID	`conversationId`	`string`	Select a value from the drop down menu.
External ID	`externalId`	`string`	The external ID of the message
Prompt	`prompt`	`string`	Prompt to send to OpenAI
Custom Persona	`customPersona`	`string`	Custom persona to use for the conversation
Chatbot Model	`chatbotModel`	`string`	Select a value from the drop down menu:`gpt-4-ogpt-5-chatgpt-4-1gpt-4o-minigpt-4-1-miniclaude-4.5-sonnetclaude-4-sonnetclaude-3.5-haikuclaude-3.5-sonnetgpt-o4-mini-lowgpt-o4-mini-mediumgpt-o4-mini-high`
Response Source	`responseSource`	`string`	Select a value from the drop down menu:`defaultown_contentopenai_content`
Custom Content	`customContent`	`string`	Custom content to use for the conversation
File Path	`file`	`string`	The path to the file saved to the `/tmp` directory (e.g. `tmp/example.pdf`). Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp. See the documentation

Authentication#

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

About CustomGPT#

CustomGPT lets you easily build your own chatbot with your own data.

More Ways to Use CustomGPT#

Triggers#

New Conversation from the CustomGPT API

Emit new event when a new conversation is created. See the documentation

Try it

New Message from the CustomGPT API

Emit new event when a new message is created in a conversation. See the documentation

Try it

Actions#

Create Conversation with the CustomGPT API

Create a new conversation for an agent (formerly known as project) identified by its unique projectId. See the documentation

Try it

Create Project (Agent) with the CustomGPT API

Create a new agent by importing data either from a sitemap or an uploaded file. The system will process the provided data and generate a new agent based on the imported or uploaded information. See the documentation

Try it