Skip to Content

OpenAI Prompt V2 activity in Jitterbit Studio

Introduction

An OpenAI Prompt V2 activity, using its OpenAI connection, creates a response for the provided prompt using OpenAI's Responses API and is intended to be used as a target to consume data in an operation. Prompt V2 behaves like the OpenAI Prompt activity but adds a wizard Chat ID field, richer response data, and the ability to call tools registered by a preceding Register Tools V2 or Register MCP Server Tools activity using the same chatId.

Note

A Prompt V2 activity only has access to tools registered by a Register Tools V2 or Register MCP Server Tools activity. It cannot use tools registered by the original Register Tools activity.

Tip

To manage chat history across operations, private agents store chat context in memory automatically. For cloud agent groups, enable the Store chat context across operations (V2 activities only) setting in the OpenAI connection configuration.

Supported OpenAI models

This activity can be configured to use one of these OpenAI models:

Create an OpenAI Prompt V2 activity

An instance of an OpenAI Prompt V2 activity is created from an OpenAI connection using its Prompt V2 activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity or tool instance in Component reuse.

An existing OpenAI Prompt V2 activity can be edited from these locations:

Configure an OpenAI Prompt V2 activity

Follow these steps to configure an OpenAI Prompt V2 activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the prompt text and optional settings. Each user interface element of this step is described below.

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a menu listing existing variables to choose from.

  • Endpoint menu: If you have multiple endpoints of the same connector type configured, a menu at the top of the screen displays the current endpoint name. Click the menu to switch to a different endpoint. For more information, see Change the assigned endpoint in Configuration screens.

    • Edit endpoint: Appears when you hover over the current endpoint name. Click to edit the currently selected endpoint's connection configuration.
  • Name: Enter a name to identify the activity. The name must be unique for each OpenAI Prompt V2 activity and must not contain forward slashes / or colons :.

  • Chat ID: Enter the chatId. If chaining this activity after a Register Tools V2 or Register MCP Server Tools activity, use the same chatId so this activity has access to the tools registered by that activity. If you don't provide a chatId, one will be automatically generated.

  • Prompt text: Enter the prompt to be used for the response.

  • Model: Use the menu to select a supported OpenAI model. The default model is gpt-4.

  • Optional settings: Click to expand additional optional settings:

    • Role: Select the prompt's role, either Assistant, System, or User:

      • Assistant: An assistant (the model) responds to the user's prompt. An assistant prompt stores previous assistant responses or can be written by you to give examples of desired behavior. This is an example of an assistant prompt:

        You have an extensive knowledge of 16th century French.

      • System: A system prompt sets the behavior of the assistant. You can modify the personality of the assistant or provide specific instructions about how it should behave. This is an example of a system prompt:

        When I ask for help to write something, you will reply with a document that contains at least one joke or playful comment in every paragraph.

      • Tool: A tool prompt is what a chatbot assistant uses to prompt OpenAI to use a tool that's been registered using a Register Tools V2 or Register MCP Server Tools activity. This is an example of a tool prompt:

        Use the Converter tool and tell me how much are 200 dollars worth in Brazilian currency.

      • User: A user prompt is a request to the assistant. This is an example of a user prompt:

        Write a Markdown list of cat breeds and a personality trait for each breed.

    • Temperature: Enter the sampling temperature. The value must be a decimal between 0 and 2. It is not recommended to use this setting with Top Probability.

    • Max Tokens: Enter the maximum number of tokens to be used.

    • Top Probability: Enter the top probability. It is not recommended to use this setting with Temperature.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

  • Data schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    The OpenAI connector uses the OpenAI Responses API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the OpenAI endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an OpenAI Prompt V2 activity, complete the configuration of the operation by adding and configuring other activities or tools as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

OpenAI Prompt V2 activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.