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

$ openai conversations create

POST/conversations

Delete a conversation

$ openai conversations delete

DELETE/conversations/{conversation_id}

Retrieve a conversation

$ openai conversations retrieve

GET/conversations/{conversation_id}

Update a conversation

$ openai conversations update

POST/conversations/{conversation_id}

ModelsExpand Collapse

computer_screenshot_content: object { detail, file_id, image_url, 2 more }

A screenshot of a computer.

conversation: object { id, created_at, metadata, object }

conversation_deleted: object { id, deleted, object }

conversation_deleted_resource: object { id, deleted, object }

message: object { id, content, role, 3 more }

A message to or from the model.

summary_text_content: object { text, type }

A summary text from the model.

text_content: object { text, type }

A text content.

ConversationsItems

Manage conversations and conversation items.

Create items

$ openai conversations:items create

POST/conversations/{conversation_id}/items

Delete an item

$ openai conversations:items delete

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

List items

$ openai conversations:items list

GET/conversations/{conversation_id}/items

Retrieve an item

$ openai conversations:items retrieve

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

ModelsExpand Collapse

conversation_item: Message { id, content, role, 3 more } or ResponseFunctionToolCallItem { id, status, created_by } or ResponseFunctionToolCallOutputItem { id, output, status, 6 more } or 25 more

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

conversation_item_list: object { data, first_id, has_more, 2 more }

A list of Conversation items.