API Reference

Conversations

Items

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create items

ConversationItemList conversations().items().create(ItemCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/conversations/{conversation_id}/items

Create items in a conversation with the given ID.

ParametersExpand Collapse

ItemCreateParams params

Optional<String> conversationId

Optional<List<ResponseIncludable>> include

Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.

List<ResponseInputItem> items

The items to add to the conversation. You may add up to 20 items at a time.

ReturnsExpand Collapse

class ConversationItemList:

A list of Conversation items.

List<ConversationItem> data

A list of conversation items.

String firstId

The ID of the first item in the list.

boolean hasMore

Whether there are more items available.

String lastId

The ID of the last item in the list.

JsonValue; object_ "list"constant"list"constant

The type of object returned, must be list.

Create items

Java

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.conversations.items.ConversationItemList;
import com.openai.models.conversations.items.ItemCreateParams;
import com.openai.models.responses.EasyInputMessage;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ItemCreateParams params = ItemCreateParams.builder()
            .conversationId("conv_123")
            .addItem(EasyInputMessage.builder()
                .content("string")
                .role(EasyInputMessage.Role.USER)
                .type(EasyInputMessage.Type.MESSAGE)
                .build())
            .build();
        ConversationItemList conversationItemList = client.conversations().items().create(params);
    }
}

{
  "object": "list",
  "data": [
    {
      "type": "message",
      "id": "msg_abc",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "Hello!"}
      ]
    },
    {
      "type": "message",
      "id": "msg_def",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "How are you?"}
      ]
    }
  ],
  "first_id": "msg_abc",
  "last_id": "msg_def",
  "has_more": false
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "type": "message",
      "id": "msg_abc",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "Hello!"}
      ]
    },
    {
      "type": "message",
      "id": "msg_def",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "How are you?"}
      ]
    }
  ],
  "first_id": "msg_abc",
  "last_id": "msg_def",
  "has_more": false
}