You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,10 @@ priority: critical
9
9
10
10
Use this operation to create, delete, list, message, or update an assistant in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself.
11
11
12
+
/// note | Assistant operations deprecated in OpenAI node V2
13
+
n8n version 1.117.0 introduces V2 of the OpenAI node that supports the OpenAI Responses API and removes support for the [to-be-deprecated Assistants API](https://platform.openai.com/docs/assistants/migration).
description: Documentation for the Conversation operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
4
+
contentType: [integration, reference]
5
+
priority: critical
6
+
---
7
+
8
+
# OpenAI Conversation operations
9
+
10
+
Use this operation to create, get, update, or remove a conversation in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself.
11
+
12
+
## Create a Conversation
13
+
14
+
Use this operation to create a new conversation.
15
+
16
+
Enter these parameters:
17
+
18
+
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
19
+
-**Resource**: Select **Conversation**.
20
+
-**Operation**: Select **Create a Conversation**.
21
+
-**Messages**: A message input to the model. Messages with the `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role will be assumed to have been generated by the model in previous interactions.
22
+
23
+
### Options
24
+
25
+
-**Metadata**: A set of key-value pairs for storing structured information. You can attach up to 16 pairs to an object, which is useful for adding custom data that can be used for searching via the API or in the dashboard.
26
+
27
+
Refer to [Conversations | OpenAI](https://platform.openai.com/docs/api-reference/conversations/create) documentation for more information.
28
+
29
+
## Get a Conversation
30
+
31
+
Use this operation to retrieve an existing conversation.
32
+
33
+
Enter these parameters:
34
+
35
+
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
36
+
-**Resource**: Select **Conversation**.
37
+
-**Operation**: Select **Get Conversation**.
38
+
-**Conversation ID**: The ID of the conversation to retrieve.
39
+
40
+
Refer to [Conversations | OpenAI](https://platform.openai.com/docs/api-reference/conversations/create) documentation for more information.
41
+
42
+
## Remove a Conversation
43
+
44
+
Use this operation to remove an existing conversation.
45
+
46
+
Enter these parameters:
47
+
48
+
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
49
+
-**Resource**: Select **Conversation**.
50
+
-**Operation**: Select **Remove Conversation**.
51
+
-**Conversation ID**: The ID of the conversation to remove.
52
+
53
+
Refer to [Conversations | OpenAI](https://platform.openai.com/docs/api-reference/conversations/create) documentation for more information.
54
+
55
+
## Update a Conversation
56
+
57
+
Use this operation to update an existing conversation.
58
+
59
+
Enter these parameters:
60
+
61
+
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
62
+
-**Resource**: Select **Conversation**.
63
+
-**Operation**: Select **Update a Conversation**.
64
+
-**Conversation ID**: The ID of the conversation to update.
65
+
66
+
### Options
67
+
68
+
-**Metadata**: A set of key-value pairs for storing structured information. You can attach up to 16 pairs to an object, which is useful for adding custom data that can be used for searching via the API or in the dashboard.
69
+
70
+
Refer to [Conversations | OpenAI](https://platform.openai.com/docs/api-reference/conversations/create) documentation for more information.
Copy file name to clipboardExpand all lines: docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/image-operations.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Enter these parameters:
18
18
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
19
19
-**Resource**: Select **Image**.
20
20
-**Operation**: Select **Analayze Image**.
21
-
-**Model**: Select the model you want to use to generate an image.
21
+
-**Model**: Select the model you want to use to analyze an image.
22
22
-**Text Input**: Ask a question about the image.
23
23
-**Input Type**: Select how you'd like to input the image. Options include:
24
24
-**Image URL(s)**: Enter the **URL(s)** of the image(s) to analyze. Add multiple URLs in a comma-separated list.
@@ -55,6 +55,30 @@ Enter these parameters:
55
55
56
56
Refer to [Create image | OpenAI](https://platform.openai.com/docs/api-reference/images/create) documentation for more information.
57
57
58
+
## Edit an Image
59
+
60
+
Use this operation to edit an image from a text prompt.
61
+
62
+
Enter these parameters:
63
+
64
+
-**Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md).
65
+
-**Resource**: Select **Image**.
66
+
-**Operation**: Select **Edit Image**.
67
+
-**Model**: Select the model you want to use to generate an image. Supports `dall-e-2` and `gpt-image-1`.
68
+
-**Prompt**: Enter the text description of the desired edits to the input image(s).
69
+
-**Image(s)**: Add one or more binary fields to include images with your prompt. Each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.
70
+
-**Number of Images**: The number of images to generate. Must be between 1 and 10.
71
+
-**Size**: The size and dimensions of the generated images (in px).
72
+
-**Quality**: The quality of the image that will be generated (auto, low, medium, high, standard). Only supported for `gpt-image-1`.
73
+
-**Output Format**: The format in which the generated images are returned (png, webp, or jpg). Only supported for gpt-image-1.
74
+
-**Output Compression**: The compression level (0-100%) for the generated images. Only supported for `gpt-image-1` with webp or jpeg output formats.
75
+
76
+
### Options
77
+
-**Background**: Allows to set transparency for the background of the generated image(s). Only supported for `gpt-image-1`.
78
+
-**Input Fidelity**: Control how much effort the model will exert to match the style and features of input images. Only supported for `gpt-image-1`.
79
+
-**Image Mask**: Name of the binary property that contains the image. A second image whose fully transparent areas (for example, where alpha is zero) shows where the image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
80
+
-**User**: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
81
+
58
82
## Common issues
59
83
60
84
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md).
Copy file name to clipboardExpand all lines: docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,9 @@ Use the OpenAI node to automate work in OpenAI and integrate OpenAI with other a
13
13
14
14
On this page, you'll find a list of operations the OpenAI node supports and links to more resources.
15
15
16
-
/// note | OpenAI Assistant node
16
+
/// note | Previous node versions
17
17
The OpenAI node replaces the OpenAI assistant node from version 1.29.0 on.
18
+
n8n version 1.117.0 introduces V2 of the OpenAI node that supports the OpenAI Responses API and removes support for the [to-be-deprecated Assistants API](https://platform.openai.com/docs/assistants/migration).
18
19
///
19
20
20
21
/// note | Credentials
@@ -23,18 +24,14 @@ Refer to [OpenAI credentials](/integrations/builtin/credentials/openai.md) for g
23
24
24
25
## Operations
25
26
26
-
-**Assistant**
27
-
- [**Create an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#create-an-assistant)
28
-
- [**Delete an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#delete-an-assistant)
0 commit comments