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

conversations.create(**kwargs) -> Conversation { id, created_at, metadata, object }

POST/conversations

Delete a conversation

conversations.delete(conversation_id) -> ConversationDeletedResource { id, deleted, object }

DELETE/conversations/{conversation_id}

Retrieve a conversation

conversations.retrieve(conversation_id) -> Conversation { id, created_at, metadata, object }

GET/conversations/{conversation_id}

Update a conversation

conversations.update(conversation_id, **kwargs) -> Conversation { id, created_at, metadata, object }

POST/conversations/{conversation_id}

ModelsExpand Collapse

class ComputerScreenshotContent { detail, file_id, image_url, 2 more }

A screenshot of a computer.

class Conversation { id, created_at, metadata, object }

class ConversationDeleted { id, deleted, object }

class ConversationDeletedResource { id, deleted, object }

class Message { id, content, role, 3 more }

A message to or from the model.

class SummaryTextContent { text, type }

A summary text from the model.

class TextContent { text, type }

A text content.

ConversationsItems

Manage conversations and conversation items.

Create items

conversations.items.create(conversation_id, **kwargs) -> ConversationItemList { data, first_id, has_more, 2 more }

POST/conversations/{conversation_id}/items

Delete an item

conversations.items.delete(item_id, **kwargs) -> Conversation { id, created_at, metadata, object }

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

List items

conversations.items.list(conversation_id, **kwargs) -> ConversationCursorPage<ConversationItem>

GET/conversations/{conversation_id}/items

Retrieve an item

conversations.items.retrieve(item_id, **kwargs) -> 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.

class ConversationItemList { data, first_id, has_more, 2 more }

A list of Conversation items.