Open Ai

Node: openAi · Full type: n8n-nodes-base.openAi · Version: 1.1

Credentials

openAiApi (alias: @open)

CREDENTIAL @open = openAiApi "My Open Ai"

Operations

Resource: chat

complete

Parameter	Type	Default	Details
model	options	"gpt-3.5-turbo"
chatModel	options	"gpt-3.5-turbo"
prompt	fixedCollection	{}	groups: messages
simplifyOutput	boolean	true
options	collection	{}	keys: echo, frequency_penalty, maxTokens, n, presence_penalty, temperature, ...

Resource: image

create

Parameter	Type	Default	Details
prompt	string	""
model	options	"dall-e-2"
imageModel	options	"dall-e-2"
responseFormat	options	"binaryData"	binaryData, imageUrl
options	collection	{}	keys: n, quality, size, size, style

Resource: text

complete

Parameter	Type	Default	Details
model	options	"gpt-3.5-turbo-instruct"
prompt	string	""
simplifyOutput	boolean	true
options	collection	{}	keys: echo, frequency_penalty, maxTokens, n, presence_penalty, temperature, ...

edit

Parameter	Type	Default	Details
model	options	"text-davinci-edit-001"	code-davinci-edit-001, text-davinci-edit-001
input	string	""
instruction	string	""
simplifyOutput	boolean	true
options	collection	{}	keys: echo, frequency_penalty, maxTokens, n, presence_penalty, temperature, ...

moderate

Parameter	Type	Default	Details
model	options	"text-moderation-latest"	text-moderation-stable, text-moderation-latest
input	string	""
simplifyOutput	boolean	true

Common Parameters

Parameter	Type	Default	Details
requestOptions	collection	{}	keys: batching, allowUnauthorizedCerts, proxy, timeout

Parameter Details

prompt children:

messages group:

Parameter	Type	Default	Details
role	options	"user"	assistant, system, user
content	string	""

options children:

Parameter	Type	Default	Details
echo	boolean	false
frequency_penalty	number	0
maxTokens	number	16
n	number	1
presence_penalty	number	0
temperature	number	1
topP	number	1

requestOptions children:

Parameter	Type	Default	Details
batching	fixedCollection	{...}	groups: batch
allowUnauthorizedCerts	boolean	false
proxy	string	""
timeout	number	10000

Example

NODE "openAi" @open AS "Open Ai" {
  resource: "chat",
  operation: "create"
}