API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Conversations

Manage conversations and conversation items.

Create a conversation

client.conversations.create(ConversationCreateParams { items, metadata } body?, RequestOptionsoptions?): Conversation { id, created_at, metadata, object }

POST/conversations

Delete a conversation

client.conversations.delete(stringconversationID, RequestOptionsoptions?): ConversationDeletedResource { id, deleted, object }

DELETE/conversations/{conversation_id}

Retrieve a conversation

client.conversations.retrieve(stringconversationID, RequestOptionsoptions?): Conversation { id, created_at, metadata, object }

GET/conversations/{conversation_id}

Update a conversation

client.conversations.update(stringconversationID, ConversationUpdateParams { metadata } body, RequestOptionsoptions?): Conversation { id, created_at, metadata, object }

POST/conversations/{conversation_id}

ModelsExpand Collapse

ComputerScreenshotContent { detail, file_id, image_url, 2 more }

A screenshot of a computer.

Conversation { id, created_at, metadata, object }

ConversationDeleted { id, deleted, object }

ConversationDeletedResource { id, deleted, object }

Message { id, content, role, 3 more }

A message to or from the model.

SummaryTextContent { text, type }

A summary text from the model.

TextContent { text, type }

A text content.

ConversationsItems

Manage conversations and conversation items.

Create items

client.conversations.items.create(stringconversationID, ItemCreateParams { items, include } params, RequestOptionsoptions?): ConversationItemList { data, first_id, has_more, 2 more }

POST/conversations/{conversation_id}/items

Delete an item

client.conversations.items.delete(stringitemID, ItemDeleteParams { conversation_id } params, RequestOptionsoptions?): Conversation { id, created_at, metadata, object }

DELETE/conversations/{conversation_id}/items/{item_id}

List items

client.conversations.items.list(stringconversationID, ItemListParams { after, include, limit, order } query?, RequestOptionsoptions?): ConversationCursorPage<ConversationItem>

GET/conversations/{conversation_id}/items

Retrieve an item

client.conversations.items.retrieve(stringitemID, ItemRetrieveParams { conversation_id, include } params, RequestOptionsoptions?): ConversationItem

GET/conversations/{conversation_id}/items/{item_id}

ModelsExpand Collapse

ConversationItem = Message { id, content, role, 3 more } | ResponseFunctionToolCallItem { id, status, created_by } | ResponseFunctionToolCallOutputItem { id, call_id, output, 6 more } | 25 more

A single item within a conversation. The set of possible types are the same as the output type of a Response object.

ConversationItemList { data, first_id, has_more, 2 more }

A list of Conversation items.