{ "opencollection": "1.0.0", "info": { "name": "OpenAI Assistants Conversations API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "List all items for a conversation with the given ID.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/conversations/:conversation_id/items", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to list items for." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.\n" }, { "name": "order", "value": "", "type": "query", "description": "The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.\n" }, { "name": "after", "value": "", "type": "query", "description": "An item ID to list items after, used in pagination.\n" }, { "name": "include", "value": "", "type": "query", "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." } ] }, "docs": "List all items for a conversation with the given ID." }, { "info": { "name": "Create items in a conversation with the given ID.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/conversations/:conversation_id/items", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to add the item to." }, { "name": "include", "value": "", "type": "query", "description": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create items in a conversation with the given ID." }, { "info": { "name": "Get a single item from a conversation with the given IDs.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/conversations/:conversation_id/items/:item_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation that contains the item." }, { "name": "item_id", "value": "", "type": "path", "description": "The ID of the item to retrieve." }, { "name": "include", "value": "", "type": "query", "description": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n" } ] }, "docs": "Get a single item from a conversation with the given IDs." }, { "info": { "name": "Delete an item from a conversation with the given IDs.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/conversations/:conversation_id/items/:item_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation that contains the item." }, { "name": "item_id", "value": "", "type": "path", "description": "The ID of the item to delete." } ] }, "docs": "Delete an item from a conversation with the given IDs." }, { "info": { "name": "Create a conversation.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/conversations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a conversation." }, { "info": { "name": "Get a conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to retrieve." } ] }, "docs": "Get a conversation" }, { "info": { "name": "Update a conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a conversation" }, { "info": { "name": "Delete a conversation. Items in the conversation will not be deleted.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to delete." } ] }, "docs": "Delete a conversation. Items in the conversation will not be deleted." } ] } ], "bundled": true }