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

Conversation conversations().create(ConversationCreateParamsparams = ConversationCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/conversations

Delete a conversation

ConversationDeletedResource conversations().delete(ConversationDeleteParamsparams = ConversationDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/conversations/{conversation_id}

Retrieve a conversation

Conversation conversations().retrieve(ConversationRetrieveParamsparams = ConversationRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/conversations/{conversation_id}

Update a conversation

Conversation conversations().update(ConversationUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/conversations/{conversation_id}

ModelsExpand Collapse

class ComputerScreenshotContent:

A screenshot of a computer.

class Conversation:

class ConversationDeleted:

class ConversationDeletedResource:

class Message:

A message to or from the model.

class SummaryTextContent:

A summary text from the model.

class TextContent:

A text content.

ConversationsItems

Manage conversations and conversation items.

Create items

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

POST/conversations/{conversation_id}/items

Delete an item

Conversation conversations().items().delete(ItemDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

List items

ItemListPage conversations().items().list(ItemListParamsparams = ItemListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/conversations/{conversation_id}/items

Retrieve an item

ConversationItem conversations().items().retrieve(ItemRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class ConversationItem: A class that can be one of several variants.union

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

class ConversationItemList:

A list of Conversation items.