OpenAI

OpenAI is a research organization that aims to develop and direct artificial intelligence (AI) in ways that benefit humanity as a whole.

Categories: artificial-intelligence

Type: openAi/v1

Connections

Version: 1

Bearer Token

Properties

Name	Label	Type	Description	Required
token	Token	STRING		true

Actions

Ask

Name: ask

Ask anything you want.

Properties

Name	Label	Type	Description	Required
model	Model	STRING Options chatgpt-4o-latest, gpt-3.5-turbo, gpt-3.5-turbo-instruct, gpt-4, gpt-4-0125-preview, gpt-4-0314, gpt-4-0613, gpt-4-1106-preview, gpt-4-turbo, gpt-4-turbo-preview, gpt-4o, gpt-4o-audio-preview, gpt-4o-mini, gpt-4o-mini-audio-preview, o1, o1-mini, o1-preview, o3-mini	ID of the model to use.	true
messages	Messages	ARRAY Items [{STRING(role), STRING(content), [FILE_ENTRY](attachments)}]	A list of messages comprising the conversation so far.	true
response	Response	OBJECT Properties {STRING(responseFormat), STRING(responseSchema)}	The response from the API.	false
maxTokens	Max Tokens	INTEGER	The maximum number of tokens to generate in the chat completion.	null
n	Number of Chat Completion Choices	INTEGER	How many chat completion choices to generate for each input message.	null
temperature	Temperature	NUMBER	Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic.	null
topP	Top P	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 10% probability mass are considered.	null
frequencyPenalty	Frequency Penalty	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.	null
presencePenalty	Presence Penalty	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 model’s likelihood to talk about new topics.	null
logitBias	Logit Bias	OBJECT Properties {}	Modify the likelihood of specified tokens appearing in the completion.	null
stop	Stop	ARRAY Items [STRING]	Up to 4 sequences where the API will stop generating further tokens.	null
user	User	STRING	A unique identifier representing your end-user, which can help admins to monitor and detect abuse.	false

Example JSON Structure

{
  "label" : "Ask",
  "name" : "ask",
  "parameters" : {
    "model" : "",
    "messages" : [ {
      "role" : "",
      "content" : "",
      "attachments" : [ {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      } ]
    } ],
    "response" : {
      "responseFormat" : "",
      "responseSchema" : ""
    },
    "maxTokens" : 1,
    "n" : 1,
    "temperature" : 0.0,
    "topP" : 0.0,
    "frequencyPenalty" : 0.0,
    "presencePenalty" : 0.0,
    "logitBias" : { },
    "stop" : [ "" ],
    "user" : ""
  },
  "type" : "openAi/v1/ask"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Create Image

Name: createImage

Create an image using text-to-image models

Properties

Name	Label	Type	Description	Required
model	Model	STRING Options dall-e-2, dall-e-3	The model to use for image generation.	true
imageMessages	Messages	ARRAY Items [{STRING(content), NUMBER(weight)}]	A list of messages comprising the conversation so far.	true
size	Size	STRING Options DALL_E_2_256x256, DALL_E_2_512x512, _1024x1024, DALL_E_3_1792x1024, DALL_E_3_1024x1792	The size of the generated images.	true
n	Number of Responses	INTEGER	The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported..	null
responseFormat	Response format	STRING Options URL, B64_JSON	The format in which the generated images are returned.	null
quality	Quality	STRING Options STANDARD, HD	The quality of the image that will be generated.	null
style	Style	STRING Options VIVID, NATURAL	The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This parameter is only supported for dall-e-3.	null
user	User	STRING	A unique identifier representing your end-user, which can help admins to monitor and detect abuse.	false

Example JSON Structure

{
  "label" : "Create Image",
  "name" : "createImage",
  "parameters" : {
    "model" : "",
    "imageMessages" : [ {
      "content" : "",
      "weight" : 0.0
    } ],
    "size" : "",
    "n" : 1,
    "responseFormat" : "",
    "quality" : "",
    "style" : "",
    "user" : ""
  },
  "type" : "openAi/v1/createImage"
}

Output

Type: OBJECT

Properties

Name	Type	Description
url	STRING
b64Json	STRING

Output Example

{
  "url" : "",
  "b64Json" : ""
}

Text-To-Speech

Name: createSpeech

Generate an audio recording from the input text

Properties

Name	Label	Type	Description	Required
model	Model	STRING Options tts-1, tts-1-hd	Text-to-Speech model which will generate the audio.	true
input	Input	STRING	The text to generate audio for.	true
voice	Voice	STRING Options ALLOY, ASH, CORAL, ECHO, FABLE, NOVA, ONYX, SAGE, SHIMMER	The voice to use when generating the audio.	true
responseFormat	Response format	STRING Options AAC, FLAC, MP3, OPUS	The format to audio in.	false
speed	Speed	NUMBER	The speed of the generated audio.	false

Example JSON Structure

{
  "label" : "Text-To-Speech",
  "name" : "createSpeech",
  "parameters" : {
    "model" : "",
    "input" : "",
    "voice" : "",
    "responseFormat" : "",
    "speed" : 0.0
  },
  "type" : "openAi/v1/createSpeech"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Create Transcriptions

Name: createTranscription

Transcribes audio into the input language.

Properties

Name	Label	Type	Description	Required
file	File	FILE_ENTRY	The audio file object to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.	true
model	Model	STRING Options whisper-1	ID of the model to use.	true
language	Language	STRING Options AF, AR, HY, AZ, BE, BS, BG, CA, ZH, HR, CS, DA, NL, EL, ET, EN, FI, FR, GL, DE, HE, HI, HU, IS, ID, IT, JA, KK, KN, KO, LT, LV, MA, MK, MR, MS, NE, NO, FA, PL, PT, RO, RU, SK, SL, SR, ES, SV, SW, TA, TL, TH, TR, UK, UR, VI, CY	The language of the input audio.	false
prompt	Prompt	STRING	An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.	false
responseFormat	Response format	STRING Options JSON, SRT, TEXT, VERBOSE_JSON, VTT	The format of the transcript output	true
temperature	Temperature	NUMBER	The sampling temperature, between 0 and 1. Higher values like will make the output more random, while lower values will make it more focused and deterministic.	false

Example JSON Structure

{
  "label" : "Create Transcriptions",
  "name" : "createTranscription",
  "parameters" : {
    "file" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "model" : "",
    "language" : "",
    "prompt" : "",
    "responseFormat" : "",
    "temperature" : 0.0
  },
  "type" : "openAi/v1/createTranscription"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Additional instructions

Connection Setup

Go to the OpenAI API.
In the left sidebar, click on API Keys.
Click Create new secret key.
Enter a name and select the project for the key and click Create secret key.
Copy the API key and use it to create a connection in ByteChef.