OpenAI

Generate text, images, and audio using OpenAI models.

AI and MLAPI key9 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (9)
ask_chatgpt
generate_image
text_to_speech
transcribe
vision_prompt
ask_assistant
custom_api_call
extract-structured-data
translate
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("openai", "ask_chatgpt", {
    "model": "<model>",
    "prompt": "<question>",
    "maxTokens": 1
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("OpenAI answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "openai-ask-chatgpt",
  name: "OpenAI: Ask ChatGPT",
  description: "Calls OpenAI when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("openai", {
      "action": "ask_chatgpt",
      "model": "<model>",
      "prompt": "<question>",
      "maxTokens": 1
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/openai/ask_chatgpt" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"model":"<model>","prompt":"<question>","maxTokens":1}}'

Actions

ask_chatgptin catalog

Ask ChatGPT. Ask ChatGPT anything you want!

Input	Type	Description
`model`required	id (picked from your account)	The model which will generate the completion. Some models are suitable for natural language tasks, others specialize in code.
`prompt`required	long text	Question
`temperature`optional	number	Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.
`maxTokens`required	number	The maximum number of tokens to generate. Requests can use up to 2,048 or 4,096 tokens shared between prompt and completion depending on the model. Don't set the value to maximum and leave some token…
`topP`optional	number	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top …
`frequencyPenalty`optional	number	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
`presencePenalty`optional	number	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the mode's likelihood to talk about new topics.
`memoryKey`optional	text	A memory key that will keep the chat history shared across runs and flows. Keep it empty to leave ChatGPT without memory of previous messages.
`roles`optional	JSON	Array of roles to specify more accurate response

generate_imagein catalog

Generate Image. Generate an image using text-to-image models

Input	Type	Description
`model`required	id (picked from your account)	The model which will generate the image.
`prompt`required	long text	Prompt
`resolution`optional	id (picked from your account)	The resolution to generate the image in.
`quality`optional	id (picked from your account)	Standard is faster, HD has better details.

text_to_speechin catalog

Text-to-Speech. Generate an audio recording from text

Input	Type	Description
`text`required	long text	The text you want to hear.
`model`required	one of "tts-1" \| "tts-1-hd"	The model which will generate the audio.
`speed`optional	number	The speed of the audio. Minimum is 0.25 and maximum is 4.00.
`voice`required	one of "alloy" \| "echo" \| "fable" \| "onyx" \| "nova" \| "shimmer"	The voice to generate the audio in.
`format`required	one of "mp3" \| "opus" \| "aac" \| "flac"	The format you want the audio file in.
`fileName`optional	text	The name of the output audio file (without extension).

transcribein catalog

Transcribe Audio. Transcribe audio to text using whisper-1 model

Input	Type	Description
`audio`required	file	Audio file to transcribe
`language`optional	one of "es" \| "it" \| "en" \| "pt" \| "de" \| "ja" \| "pl" \| "ar" \| "af" \| "az" \| "bg" \| "bs"	Language of the audio file the default is en (English).

vision_promptin catalog

Vision Prompt. Ask GPT a question about an image

Input	Type	Description
`image`required	file	The image URL or file you want GPT's vision to read.
`prompt`required	long text	What do you want ChatGPT to tell you about the image?
`detail`optional	id (picked from your account)	Control how the model processes the image and generates textual understanding.
`temperature`optional	number	Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.
`maxTokens`optional	number	The maximum number of tokens to generate. Requests can use up to 2,048 or 4,096 tokens shared between prompt and completion, don't set the value to maximum and leave some tokens for the input. The ex…
`topP`optional	number	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top …
`frequencyPenalty`optional	number	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
`presencePenalty`optional	number	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the mode's likelihood to talk about new topics.
`roles`optional	JSON	Array of roles to specify more accurate response

ask_assistant

Ask Assistant. Ask a GPT assistant anything you want!

Input	Type	Description
`assistant`required	id (picked from your account)	The assistant which will generate the completion.
`prompt`required	long text	Question
`memoryKey`optional	text	A memory key that will keep the chat history shared across runs and flows. Keep it empty to leave your assistant without memory of previous messages.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

extract-structured-data

Extract Structured Data from Text. Returns structured data from provided unstructured text.

Input	Type	Description
`model`required	id (picked from your account)	Model
`text`required	long text	Unstructured Text
`params`required	array	Data Definition

translate

Translate Audio. Translate audio to text using whisper-1 model

Input	Type	Description
`audio`required	file	Audio file to translate

Details

Id: openai
Category: AI and ML
Tags: ai, gpt, chatgpt, dall-e, whisper
Package: @activepieces/piece-openai@0.7.5
Tier: Built in