Constructor Detail

Method Detail

• body

   final ConversationCreateParams.Builder body(ConversationCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • items

  • metadata

• items

   final ConversationCreateParams.Builder items(List<ResponseInputItem> items)

  Initial items to include in the conversation context. You may add up to 20 items at a time.

• items

   final ConversationCreateParams.Builder items(Optional<List<ResponseInputItem>> items)

  Alias for calling Builder.items with items.orElse(null).

• items

   final ConversationCreateParams.Builder items(JsonField<List<ResponseInputItem>> items)

  Sets Builder.items to an arbitrary JSON value.

  You should usually call Builder.items with a well-typed List<ResponseInputItem> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem item)

  Adds a single ResponseInputItem to items.

• addItem

   final ConversationCreateParams.Builder addItem(EasyInputMessage easyInputMessage)

  Alias for calling addItem with ResponseInputItem.ofEasyInputMessage(easyInputMessage).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.Message message)

  Alias for calling addItem with ResponseInputItem.ofMessage(message).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseOutputMessage responseOutputMessage)

  Alias for calling addItem with ResponseInputItem.ofResponseOutputMessage(responseOutputMessage).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseFileSearchToolCall fileSearchCall)

  Alias for calling addItem with ResponseInputItem.ofFileSearchCall(fileSearchCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseComputerToolCall computerCall)

  Alias for calling addItem with ResponseInputItem.ofComputerCall(computerCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.ComputerCallOutput computerCallOutput)

  Alias for calling addItem with ResponseInputItem.ofComputerCallOutput(computerCallOutput).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseFunctionWebSearch webSearchCall)

  Alias for calling addItem with ResponseInputItem.ofWebSearchCall(webSearchCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseFunctionToolCall functionCall)

  Alias for calling addItem with ResponseInputItem.ofFunctionCall(functionCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.FunctionCallOutput functionCallOutput)

  Alias for calling addItem with ResponseInputItem.ofFunctionCallOutput(functionCallOutput).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseReasoningItem reasoning)

  Alias for calling addItem with ResponseInputItem.ofReasoning(reasoning).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.ImageGenerationCall imageGenerationCall)

  Alias for calling addItem with ResponseInputItem.ofImageGenerationCall(imageGenerationCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseCodeInterpreterToolCall codeInterpreterCall)

  Alias for calling addItem with ResponseInputItem.ofCodeInterpreterCall(codeInterpreterCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.LocalShellCall localShellCall)

  Alias for calling addItem with ResponseInputItem.ofLocalShellCall(localShellCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.LocalShellCallOutput localShellCallOutput)

  Alias for calling addItem with ResponseInputItem.ofLocalShellCallOutput(localShellCallOutput).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.McpListTools mcpListTools)

  Alias for calling addItem with ResponseInputItem.ofMcpListTools(mcpListTools).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.McpApprovalRequest mcpApprovalRequest)

  Alias for calling addItem with ResponseInputItem.ofMcpApprovalRequest(mcpApprovalRequest).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.McpApprovalResponse mcpApprovalResponse)

  Alias for calling addItem with ResponseInputItem.ofMcpApprovalResponse(mcpApprovalResponse).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.McpCall mcpCall)

  Alias for calling addItem with ResponseInputItem.ofMcpCall(mcpCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseCustomToolCallOutput customToolCallOutput)

  Alias for calling addItem with ResponseInputItem.ofCustomToolCallOutput(customToolCallOutput).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseCustomToolCall customToolCall)

  Alias for calling addItem with ResponseInputItem.ofCustomToolCall(customToolCall).

• addItem

   final ConversationCreateParams.Builder addItem(ResponseInputItem.ItemReference itemReference)

  Alias for calling addItem with ResponseInputItem.ofItemReference(itemReference).

• addItemReferenceItem

   final ConversationCreateParams.Builder addItemReferenceItem(String id)

  Alias for calling addItem with the following:

  ResponseInputItem.ItemReference.builder()
      .type(ResponseInputItem.ItemReference.Type.ITEM_REFERENCE)
      .id(id)
      .build()

• metadata

   final ConversationCreateParams.Builder metadata(ConversationCreateParams.Metadata metadata)

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• metadata

   final ConversationCreateParams.Builder metadata(Optional<ConversationCreateParams.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final ConversationCreateParams.Builder metadata(JsonField<ConversationCreateParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final ConversationCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final ConversationCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final ConversationCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final ConversationCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final ConversationCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final ConversationCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final ConversationCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final ConversationCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final ConversationCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final ConversationCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final ConversationCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final ConversationCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final ConversationCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final ConversationCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final ConversationCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final ConversationCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final ConversationCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final ConversationCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final ConversationCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final ConversationCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final ConversationCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final ConversationCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final ConversationCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final ConversationCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final ConversationCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final ConversationCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final ConversationCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final ConversationCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final ConversationCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final ConversationCreateParams build()

  Returns an immutable instance of ConversationCreateParams.

  Further updates to this Builder will not mutate the returned instance.