⋙ Create Conversation

Create a new conversation.

msg.payload Properties

items array

Optional initial conversation items. For assistant message items in the array, you may also set phase to commentary or final_answer.

metadata object

Optional key-value metadata for the conversation.

⋙ Retrieve Conversation

Retrieve a conversation by id.

msg.payload Properties

conversation_id string

The conversation id.

⋙ Modify Conversation

Update a conversation by id.

msg.payload Properties

conversation_id string

The conversation id.

metadata object

Metadata to set on the conversation.

⋙ Delete Conversation

Delete a conversation by id.

msg.payload Properties

conversation_id string

The conversation id.

⋙ Create Conversation Item

Add an item to a conversation.

msg.payload Properties

conversation_id string

The conversation id.

items array

Conversation items to append. Assistant messages in the array may also set phase to commentary or final_answer. Preserve assistant-message phase on follow-up requests; dropping it can degrade performance. phase is not required for user messages. The array may also include additional_tools items. For create-item input, send role: "developer", a tools array, and optional id.

⋙ Retrieve Conversation Item

Retrieve a single conversation item by id.

msg.payload Properties

conversation_id string

The conversation id.

item_id string

The item id.

⋙ List Conversation Items

List items for a conversation.

msg.payload Properties

conversation_id string

The conversation id.

after string

Pagination cursor to return items after this item id.

limit integer

Maximum number of items to return.

order string

Sort order, typically asc or desc.

⋙ Delete Conversation Item

Delete a single conversation item by id.

msg.payload Properties

conversation_id string

The conversation id.

item_id string

The item id.