List items

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

GET/conversations/{conversation_id}/items

List all items for a conversation with the given ID.

ParametersExpand Collapse

conversation_id: String

after: String

An item ID to list items after, used in pagination.

include: Array[ResponseIncludable]

Specify additional output data to include in the model response. Currently supported values are:

web_search_call.action.sources: Include the sources of the web search tool call.
code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
computer_call_output.output.image_url: Include image urls from the computer call output.
file_search_call.results: Include the search results of the file search tool call.
message.input_image.image_url: Include image urls from the input message.
message.output_text.logprobs: Include logprobs with assistant messages.
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).

One of the following:

:"file_search_call.results"

:"web_search_call.action.sources"

:"message.input_image.image_url"

:"computer_call_output.output.image_url"

:"code_interpreter_call.outputs"

:"reasoning.encrypted_content"

:"message.output_text.logprobs"

limit: Integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order: :asc | :desc

The order to return the input items in. Default is desc.

asc: Return the input items in ascending order.
desc: Return the input items in descending order.

One of the following:

:asc

:desc

ReturnsExpand Collapse

ConversationItem = Message { id, content, role, 2 more } | ResponseFunctionToolCallItem { id, status, created_by } | ResponseFunctionToolCallOutputItem { id, call_id, output, 3 more } | 22 more

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

One of the following:

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

A message to or from the model.

id: String

The unique ID of the message.

content: Array[ResponseInputText { text, type } | ResponseOutputText { annotations, text, type, logprobs } | TextContent { text, type } | 6 more]

The content of the message

One of the following:

class ResponseInputText { text, type }

A text input to the model.

text: String

The text input to the model.

type: :input_text

The type of the input item. Always input_text.

class ResponseOutputText { annotations, text, type, logprobs }

A text output from the model.

annotations: Array[{ file_id, filename, index, type} | { end_index, start_index, title, 2 more} | { container_id, end_index, file_id, 3 more} | { file_id, index, type}]

The annotations of the text output.

One of the following:

class FileCitation { file_id, filename, index, type }

A citation to a file.

file_id: String

The ID of the file.

filename: String

The filename of the file cited.

index: Integer

The index of the file in the list of files.

type: :file_citation

The type of the file citation. Always file_citation.

class URLCitation { end_index, start_index, title, 2 more }

A citation for a web resource used to generate a model response.

end_index: Integer

The index of the last character of the URL citation in the message.

start_index: Integer

The index of the first character of the URL citation in the message.

title: String

The title of the web resource.

type: :url_citation

The type of the URL citation. Always url_citation.

url: String

The URL of the web resource.

class ContainerFileCitation { container_id, end_index, file_id, 3 more }

A citation for a container file used to generate a model response.

container_id: String

The ID of the container file.

end_index: Integer

The index of the last character of the container file citation in the message.

file_id: String

The ID of the file.

filename: String

The filename of the container file cited.

start_index: Integer

The index of the first character of the container file citation in the message.

type: :container_file_citation

The type of the container file citation. Always container_file_citation.

class FilePath { file_id, index, type }

A path to a file.

file_id: String

The ID of the file.

index: Integer

The index of the file in the list of files.

type: :file_path

The type of the file path. Always file_path.

text: String

The text output from the model.

type: :output_text

The type of the output text. Always output_text.

logprobs: Array[{ token, bytes, logprob, top_logprobs}]

token: String

bytes: Array[Integer]

logprob: Float

top_logprobs: Array[{ token, bytes, logprob}]

token: String

bytes: Array[Integer]

logprob: Float

class TextContent { text, type }

A text content.

text: String

type: :text

class SummaryTextContent { text, type }

A summary text from the model.

text: String

A summary of the reasoning output from the model so far.

type: :summary_text

The type of the object. Always summary_text.

class ReasoningText { text, type }

Reasoning text from the model.

text: String

The reasoning text from the model.

type: :reasoning_text

The type of the reasoning text. Always reasoning_text.

class ResponseOutputRefusal { refusal, type }

A refusal from the model.

refusal: String

The refusal explanation from the model.

type: :refusal

The type of the refusal. Always refusal.

class ResponseInputImage { detail, type, file_id, image_url }

An image input to the model. Learn about image inputs.

detail: :low | :high | :auto | :original

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

One of the following:

:low

:high

:auto

:original

type: :input_image

The type of the input item. Always input_image.

file_id: String

The ID of the file to be sent to the model.

image_url: String

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ComputerScreenshotContent { detail, file_id, image_url, type }

A screenshot of a computer.

detail: :low | :high | :auto | :original

The detail level of the screenshot image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

One of the following:

:low

:high

:auto

:original

file_id: String

The identifier of an uploaded file that contains the screenshot.

image_url: String

The URL of the screenshot image.

type: :computer_screenshot

Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.

class ResponseInputFile { type, file_data, file_id, 2 more }

A file input to the model.

type: :input_file

The type of the input item. Always input_file.

file_data: String

The content of the file to be sent to the model.

file_id: String

The ID of the file to be sent to the model.

file_url: String

The URL of the file to be sent to the model.

filename: String

The name of the file to be sent to the model.

role: :unknown | :user | :assistant | 5 more

The role of the message. One of unknown, user, assistant, system, critic, discriminator, developer, or tool.

One of the following:

:unknown

:user

:assistant

:system

:critic

:discriminator

:developer

:tool

status: :in_progress | :completed | :incomplete

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

:in_progress

:completed

:incomplete

type: :message

The type of the message. Always set to message.

class ResponseFunctionToolCallItem { id, status, created_by }

A tool call to run a function. See the function calling guide for more information.

id: String

The unique ID of the function tool call.

status: :in_progress | :completed | :incomplete

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

:in_progress

:completed

:incomplete

created_by: String

The identifier of the actor that created the item.

class ResponseFunctionToolCallOutputItem { id, call_id, output, 3 more }

id: String

The unique ID of the function call tool output.

call_id: String

The unique ID of the function tool call generated by the model.

output: String | Array[ResponseInputText { text, type } | ResponseInputImage { detail, type, file_id, image_url } | ResponseInputFile { type, file_data, file_id, 2 more } ]

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

A string of the output of the function call.

Array[ResponseInputText { text, type } | ResponseInputImage { detail, type, file_id, image_url } | ResponseInputFile { type, file_data, file_id, 2 more } ]

Text, image, or file output of the function call.

One of the following:

class ResponseInputText { text, type }

A text input to the model.

text: String

The text input to the model.

type: :input_text

The type of the input item. Always input_text.

class ResponseInputImage { detail, type, file_id, image_url }

An image input to the model. Learn about image inputs.

detail: :low | :high | :auto | :original

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

One of the following:

:low

:high

:auto

:original

type: :input_image

The type of the input item. Always input_image.

file_id: String

The ID of the file to be sent to the model.

image_url: String

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ResponseInputFile { type, file_data, file_id, 2 more }

A file input to the model.

type: :input_file

The type of the input item. Always input_file.

file_data: String

The content of the file to be sent to the model.

file_id: String

The ID of the file to be sent to the model.

file_url: String

The URL of the file to be sent to the model.

filename: String

The name of the file to be sent to the model.

status: :in_progress | :completed | :incomplete

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

:in_progress

:completed

:incomplete

type: :function_call_output

The type of the function tool call output. Always function_call_output.

created_by: String

The identifier of the actor that created the item.

class ResponseFileSearchToolCall { id, queries, status, 2 more }

The results of a file search tool call. See the file search guide for more information.

id: String

The unique ID of the file search tool call.

queries: Array[String]

The queries used to search for files.

status: :in_progress | :searching | :completed | 2 more

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

:in_progress

:searching

:completed

:incomplete

:failed

type: :file_search_call

The type of the file search tool call. Always file_search_call.

results: Array[{ attributes, file_id, filename, 2 more}]

The results of the file search tool call.

attributes: Hash[Symbol, String | Float | bool]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

One of the following:

String

Float

bool

file_id: String

The unique ID of the file.

filename: String

The name of the file.

score: Float

The relevance score of the file - a value between 0 and 1.

formatfloat

text: String

The text that was retrieved from the file.

class ResponseFunctionWebSearch { id, action, status, type }

The results of a web search tool call. See the web search guide for more information.

id: String

The unique ID of the web search tool call.

action: { query, type, queries, sources} | { type, url} | { pattern, type, url}

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).

One of the following:

class Search { query, type, queries, sources }

Action type "search" - Performs a web search query.

query: String

[DEPRECATED] The search query.

type: :search

The action type.

queries: Array[String]

The search queries.

sources: Array[{ type, url}]

The sources used in the search.

type: :url

The type of source. Always url.

url: String

The URL of the source.

class OpenPage { type, url }

Action type "open_page" - Opens a specific URL from search results.

type: :open_page

The action type.

url: String

The URL opened by the model.

formaturi

class FindInPage { pattern, type, url }

Action type "find_in_page": Searches for a pattern within a loaded page.

pattern: String

The pattern or text to search for within the page.

type: :find_in_page

The action type.

url: String

The URL of the page searched for the pattern.

formaturi

status: :in_progress | :searching | :completed | :failed

The status of the web search tool call.

One of the following:

:in_progress

:searching

:completed

:failed

type: :web_search_call

The type of the web search tool call. Always web_search_call.

class ImageGenerationCall { id, result, status, type }

An image generation request made by the model.

id: String

The unique ID of the image generation call.

result: String

The generated image encoded in base64.

status: :in_progress | :completed | :generating | :failed

The status of the image generation call.

One of the following:

:in_progress

:completed

:generating

:failed

type: :image_generation_call

The type of the image generation call. Always image_generation_call.

class ResponseComputerToolCall { id, call_id, pending_safety_checks, 4 more }

A tool call to a computer use tool. See the computer use guide for more information.

id: String

The unique ID of the computer call.

call_id: String

An identifier used when responding to the tool call with output.

pending_safety_checks: Array[{ id, code, message}]

The pending safety checks for the computer call.

id: String

The ID of the pending safety check.

code: String

The type of the pending safety check.

message: String

Details about the pending safety check.

status: :in_progress | :completed | :incomplete

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

:in_progress

:completed

:incomplete

type: :computer_call

The type of the computer call. Always computer_call.

action: { button, type, x, 2 more} | { keys, type, x, y_} | { path, type, keys} | 6 more

A click action.

One of the following:

class Click { button, type, x, 2 more }

A click action.

button: :left | :right | :wheel | 2 more

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

:left

:right

:wheel

:back

:forward

type: :click

Specifies the event type. For a click action, this property is always click.

x: Integer

The x-coordinate where the click occurred.

y_: Integer

The y-coordinate where the click occurred.

keys: Array[String]

The keys being held while clicking.

class DoubleClick { keys, type, x, y_ }

A double click action.

keys: Array[String]

The keys being held while double-clicking.

type: :double_click

Specifies the event type. For a double click action, this property is always set to double_click.

x: Integer

The x-coordinate where the double click occurred.

y_: Integer

The y-coordinate where the double click occurred.

class Drag { path, type, keys }

A drag action.

path: Array[{ x, y_}]

An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg

[
  { x: 100, y: 200 },
  { x: 200, y: 300 }
]

x: Integer

The x-coordinate.

y_: Integer

The y-coordinate.

type: :drag

Specifies the event type. For a drag action, this property is always set to drag.

keys: Array[String]

The keys being held while dragging the mouse.

class Keypress { keys, type }

A collection of keypresses the model would like to perform.

keys: Array[String]

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

type: :keypress

Specifies the event type. For a keypress action, this property is always set to keypress.

class Move { type, x, y_, keys }

A mouse move action.

type: :move

Specifies the event type. For a move action, this property is always set to move.

x: Integer

The x-coordinate to move to.

y_: Integer

The y-coordinate to move to.

keys: Array[String]

The keys being held while moving the mouse.

class Screenshot { type }

A screenshot action.

type: :screenshot

Specifies the event type. For a screenshot action, this property is always set to screenshot.

class Scroll { scroll_x, scroll_y, type, 3 more }

A scroll action.

scroll_x: Integer

The horizontal scroll distance.

scroll_y: Integer

The vertical scroll distance.

type: :scroll

Specifies the event type. For a scroll action, this property is always set to scroll.

x: Integer

The x-coordinate where the scroll occurred.

y_: Integer

The y-coordinate where the scroll occurred.

keys: Array[String]

The keys being held while scrolling.

class Type { text, type }

An action to type in text.

text: String

The text to type.

type: :type

Specifies the event type. For a type action, this property is always set to type.

class Wait { type }

A wait action.

type: :wait

Specifies the event type. For a wait action, this property is always set to wait.

actions: ComputerActionList { Click, DoubleClick, Drag, 6 more }

Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.

One of the following:

class Click { button, type, x, 2 more }

A click action.

button: :left | :right | :wheel | 2 more

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

:left

:right

:wheel

:back

:forward

type: :click

Specifies the event type. For a click action, this property is always click.

x: Integer

The x-coordinate where the click occurred.

y_: Integer

The y-coordinate where the click occurred.

keys: Array[String]

The keys being held while clicking.

class DoubleClick { keys, type, x, y_ }

A double click action.

keys: Array[String]

The keys being held while double-clicking.

type: :double_click

Specifies the event type. For a double click action, this property is always set to double_click.

x: Integer

The x-coordinate where the double click occurred.

y_: Integer

The y-coordinate where the double click occurred.

class Drag { path, type, keys }

A drag action.

path: Array[{ x, y_}]

An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg

[
  { x: 100, y: 200 },
  { x: 200, y: 300 }
]

x: Integer

The x-coordinate.

y_: Integer

The y-coordinate.

type: :drag

Specifies the event type. For a drag action, this property is always set to drag.

keys: Array[String]

The keys being held while dragging the mouse.

class Keypress { keys, type }

A collection of keypresses the model would like to perform.

keys: Array[String]

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

type: :keypress

Specifies the event type. For a keypress action, this property is always set to keypress.

class Move { type, x, y_, keys }

A mouse move action.

type: :move

Specifies the event type. For a move action, this property is always set to move.

x: Integer

The x-coordinate to move to.

y_: Integer

The y-coordinate to move to.

keys: Array[String]

The keys being held while moving the mouse.

class Screenshot { type }

A screenshot action.

type: :screenshot

Specifies the event type. For a screenshot action, this property is always set to screenshot.

class Scroll { scroll_x, scroll_y, type, 3 more }

A scroll action.

scroll_x: Integer

The horizontal scroll distance.

scroll_y: Integer

The vertical scroll distance.

type: :scroll

Specifies the event type. For a scroll action, this property is always set to scroll.

x: Integer

The x-coordinate where the scroll occurred.

y_: Integer

The y-coordinate where the scroll occurred.

keys: Array[String]

The keys being held while scrolling.

class Type { text, type }

An action to type in text.

text: String

The text to type.

type: :type

Specifies the event type. For a type action, this property is always set to type.

class Wait { type }

A wait action.

type: :wait

Specifies the event type. For a wait action, this property is always set to wait.

class ResponseComputerToolCallOutputItem { id, call_id, output, 4 more }

id: String

The unique ID of the computer call tool output.

call_id: String

The ID of the computer tool call that produced the output.

output: ResponseComputerToolCallOutputScreenshot { type, file_id, image_url }

A computer screenshot image used with the computer use tool.

type: :computer_screenshot

Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.

file_id: String

The identifier of an uploaded file that contains the screenshot.

image_url: String

The URL of the screenshot image.

status: :completed | :incomplete | :failed | :in_progress

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.

One of the following:

:completed

:incomplete

:failed

:in_progress

type: :computer_call_output

The type of the computer tool call output. Always computer_call_output.

acknowledged_safety_checks: Array[{ id, code, message}]

The safety checks reported by the API that have been acknowledged by the developer.

id: String

The ID of the pending safety check.

code: String

The type of the pending safety check.

message: String

Details about the pending safety check.

created_by: String

The identifier of the actor that created the item.

class ResponseToolSearchCall { id, arguments, call_id, 4 more }

id: String

The unique ID of the tool search call item.

arguments: untyped

Arguments used for the tool search call.

call_id: String

The unique ID of the tool search call generated by the model.

execution: :server | :client

Whether tool search was executed by the server or by the client.

One of the following:

:server

:client

status: :in_progress | :completed | :incomplete

The status of the tool search call item that was recorded.

One of the following:

:in_progress

:completed

:incomplete

type: :tool_search_call

The type of the item. Always tool_search_call.

created_by: String

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem { id, call_id, execution, 4 more }

id: String

The unique ID of the tool search output item.

call_id: String

The unique ID of the tool search call generated by the model.

execution: :server | :client

Whether tool search was executed by the server or by the client.

One of the following:

:server

:client

status: :in_progress | :completed | :incomplete

The status of the tool search output item that was recorded.

One of the following:

:in_progress

:completed

:incomplete

tools: Array[Tool]

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool { name, parameters, strict, 3 more }

Defines a function in your own code the model can choose to call. Learn more about function calling.

The name of the function to call.

parameters: Hash[Symbol, untyped]

A JSON schema object describing the parameters of the function.

strict: bool

Whether to enforce strict parameter validation. Default true.

type: :function

The type of the function tool. Always function.

defer_loading: bool

Whether this function is deferred and loaded via tool search.

description: String

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool { type, vector_store_ids, filters, 2 more }

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

type: :file_search

The type of the file search tool. Always file_search.

vector_store_ids: Array[String]

The IDs of the vector stores to search.

filters: ComparisonFilter { key, type, value } | CompoundFilter { filters, type }

A filter to apply.

One of the following:

class ComparisonFilter { key, type, value }

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

key: String

The key to compare against the value.

type: :eq | :ne | :gt | 5 more

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in

One of the following:

:eq

:ne

:gt

:gte

:lt

:lte

:in

:nin

value: String | Float | bool | Array[String | Float]

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

Float

bool

Array[String | Float]

One of the following:

String

Float

class CompoundFilter { filters, type }

Combine multiple filters using and or or.

filters: Array[ComparisonFilter { key, type, value } | untyped]

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter { key, type, value }

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

key: String

The key to compare against the value.

type: :eq | :ne | :gt | 5 more

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in

One of the following:

:eq

:ne

:gt

:gte

:lt

:lte

:in

:nin

value: String | Float | bool | Array[String | Float]

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

Float

bool

Array[String | Float]

One of the following:

String

Float

untyped

type: :and | :or

Type of operation: and or or.

One of the following:

:and

:or

max_num_results: Integer

The maximum number of results to return. This number should be between 1 and 50 inclusive.

ranking_options: { hybrid_search, ranker, score_threshold}

Ranking options for search.

hybrid_search: { embedding_weight, text_weight}

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

embedding_weight: Float

The weight of the embedding in the reciprocal ranking fusion.

text_weight: Float

The weight of the text in the reciprocal ranking fusion.

ranker: :auto | :"default-2024-11-15"

The ranker to use for the file search.

One of the following:

:auto

:"default-2024-11-15"

score_threshold: Float

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool { type }

A tool that controls a virtual computer. Learn more about the computer tool.

type: :computer

The type of the computer tool. Always computer.

class ComputerUsePreviewTool { display_height, display_width, environment, type }

A tool that controls a virtual computer. Learn more about the computer tool.

display_height: Integer

The height of the computer display.

display_width: Integer

The width of the computer display.

environment: :windows | :mac | :linux | 2 more

The type of computer environment to control.

One of the following:

:windows

:mac

:linux

:ubuntu

:browser

type: :computer_use_preview

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool { type, filters, search_context_size, user_location }

Search the Internet for sources related to the prompt. Learn more about the web search tool.

type: :web_search | :web_search_2025_08_26

The type of the web search tool. One of web_search or web_search_2025_08_26.

One of the following:

:web_search

:web_search_2025_08_26

filters: { allowed_domains}

Filters for the search.

allowed_domains: Array[String]

Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.

Example: ["pubmed.ncbi.nlm.nih.gov"]

search_context_size: :low | :medium | :high

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

One of the following:

:low

:medium

:high

user_location: { city, country, region, 2 more}

The approximate location of the user.

city: String

Free text input for the city of the user, e.g. San Francisco.

country: String

The two-letter ISO country code of the user, e.g. US.

region: String

Free text input for the region of the user, e.g. California.

timezone: String

The IANA timezone of the user, e.g. America/Los_Angeles.

type: :approximate

The type of location approximation. Always approximate.

class Mcp { server_label, type, allowed_tools, 7 more }

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

server_label: String

A label for this MCP server, used to identify it in tool calls.

type: :mcp

The type of the MCP tool. Always mcp.

allowed_tools: Array[String] | { read_only, tool_names}

List of allowed tool names or a filter object.

One of the following:

Array[String]

A string array of allowed tool names

class McpToolFilter { read_only, tool_names }

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

authorization: String

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

connector_id: :connector_dropbox | :connector_gmail | :connector_googlecalendar | 5 more

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

Currently supported connector_id values are:

Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint

One of the following:

:connector_dropbox

:connector_gmail

:connector_googlecalendar

:connector_googledrive

:connector_microsoftteams

:connector_outlookcalendar

:connector_outlookemail

:connector_sharepoint

defer_loading: bool

Whether this MCP tool is deferred and discovered via tool search.

headers: Hash[Symbol, String]

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

require_approval: { always, never} | :always | :never

Specify which of the MCP server's tools require approval.

One of the following:

class McpToolApprovalFilter { always, never }

Specify which of the MCP server's tools require approval. Can be always, never, or a filter object associated with tools that require approval.

always: { read_only, tool_names}

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

never: { read_only, tool_names}

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

McpToolApprovalSetting = :always | :never

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

One of the following:

:always

:never

server_description: String

Optional description of the MCP server, used to provide more context.

server_url: String

The URL for the MCP server. One of server_url or connector_id must be provided.

class CodeInterpreter { container, type }

A tool that runs Python code to help generate a response to a prompt.

container: String | { type, file_ids, memory_limit, network_policy}

The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code, along with an optional memory_limit setting.

One of the following:

String

The container ID.

class CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy }

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

type: :auto

Always auto.

file_ids: Array[String]

An optional list of uploaded files to make available to your code.

memory_limit: :"1g" | :"4g" | :"16g" | :"64g"

The memory limit for the code interpreter container.

One of the following:

:"1g"

:"4g"

:"16g"

:"64g"

network_policy: ContainerNetworkPolicyDisabled { type } | ContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled { type }

type: :disabled

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

allowed_domains: Array[String]

A list of allowed domains when type is allowlist.

type: :allowlist

Allow outbound network access only to specified domains. Always allowlist.

domain_secrets: Array[ContainerNetworkPolicyDomainSecret { domain, name, value } ]

Optional domain-scoped secrets for allowlisted domains.

domain: String

The domain associated with the secret.

minLength1

The name of the secret to inject for the domain.

minLength1

value: String

The secret value to inject for the domain.

maxLength10485760

minLength1

type: :code_interpreter

The type of the code interpreter tool. Always code_interpreter.

class ImageGeneration { type, action, background, 9 more }

A tool that generates images using the GPT image models.

type: :image_generation

The type of the image generation tool. Always image_generation.

action: :generate | :edit | :auto

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

:generate

:edit

:auto

background: :transparent | :opaque | :auto

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

:transparent

:opaque

:auto

input_fidelity: :high | :low

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

:high

:low

input_image_mask: { file_id, image_url}

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

file_id: String

File ID for the mask image.

image_url: String

Base64-encoded mask image.

model: String | :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-1.5"

The image generation model to use. Default: gpt-image-1.

One of the following:

String

:"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-1.5"

The image generation model to use. Default: gpt-image-1.

One of the following:

:"gpt-image-1"

:"gpt-image-1-mini"

:"gpt-image-1.5"

moderation: :auto | :low

Moderation level for the generated image. Default: auto.

One of the following:

:auto

:low

output_compression: Integer

Compression level for the output image. Default: 100.

minimum0

maximum100

output_format: :png | :webp | :jpeg

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

:png

:webp

:jpeg

partial_images: Integer

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

quality: :low | :medium | :high | :auto

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

:low

:medium

:high

:auto

size: :"1024x1024" | :"1024x1536" | :"1536x1024" | :auto

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

:"1024x1024"

:"1024x1536"

:"1536x1024"

:auto

class LocalShell { type }

A tool that allows the model to execute shell commands in a local environment.

type: :local_shell

The type of the local shell tool. Always local_shell.

class FunctionShellTool { type, environment }

A tool that allows the model to execute shell commands.

type: :shell

The type of the shell tool. Always shell.

environment: ContainerAuto { type, file_ids, memory_limit, 2 more } | LocalEnvironment { type, skills } | ContainerReference { container_id, type }

One of the following:

class ContainerAuto { type, file_ids, memory_limit, 2 more }

type: :container_auto

Automatically creates a container for this request

file_ids: Array[String]

An optional list of uploaded files to make available to your code.

memory_limit: :"1g" | :"4g" | :"16g" | :"64g"

The memory limit for the container.

One of the following:

:"1g"

:"4g"

:"16g"

:"64g"

network_policy: ContainerNetworkPolicyDisabled { type } | ContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled { type }

type: :disabled

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

allowed_domains: Array[String]

A list of allowed domains when type is allowlist.

type: :allowlist

Allow outbound network access only to specified domains. Always allowlist.

domain_secrets: Array[ContainerNetworkPolicyDomainSecret { domain, name, value } ]

Optional domain-scoped secrets for allowlisted domains.

domain: String

The domain associated with the secret.

minLength1

The name of the secret to inject for the domain.

minLength1

value: String

The secret value to inject for the domain.

maxLength10485760

minLength1

skills: Array[SkillReference { skill_id, type, version } | InlineSkill { description, name, source, type } ]

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference { skill_id, type, version }

skill_id: String

The ID of the referenced skill.

maxLength64

minLength1

type: :skill_reference

References a skill created with the /v1/skills endpoint.

version: String

Optional skill version. Use a positive integer or 'latest'. Omit for default.

class InlineSkill { description, name, source, type }

description: String

The description of the skill.

The name of the skill.

source: InlineSkillSource { data, media_type, type }

Inline skill payload

data: String

Base64-encoded skill zip bundle.

maxLength70254592

minLength1

media_type: :"application/zip"

The media type of the inline skill payload. Must be application/zip.

type: :base64

The type of the inline skill source. Must be base64.

type: :inline

Defines an inline skill for this request.

class LocalEnvironment { type, skills }

type: :local

Use a local computer environment.

skills: Array[LocalSkill { description, name, path } ]

An optional list of skills.

description: String

The description of the skill.

The name of the skill.

path: String

The path to the directory containing the skill.

class ContainerReference { container_id, type }

container_id: String

The ID of the referenced container.

type: :container_reference

References a container created with the /v1/containers endpoint

class CustomTool { name, type, defer_loading, 2 more }

A custom tool that processes input using a specified format. Learn more about custom tools

The name of the custom tool, used to identify it in tool calls.

type: :custom

The type of the custom tool. Always custom.

defer_loading: bool

Whether this tool should be deferred and discovered via tool search.

description: String

Optional description of the custom tool, used to provide more context.

format_: CustomToolInputFormat

The input format for the custom tool. Default is unconstrained text.

One of the following:

class Text { type }

Unconstrained free-form text.

type: :text

Unconstrained text format. Always text.

class Grammar { definition, syntax, type }

A grammar defined by the user.

definition: String

The grammar definition.

syntax: :lark | :regex

The syntax of the grammar definition. One of lark or regex.

One of the following:

:lark

:regex

type: :grammar

Grammar format. Always grammar.

class NamespaceTool { description, name, tools, type }

Groups function/custom tools under a shared namespace.

description: String

A description of the namespace shown to the model.

minLength1

The namespace name used in tool calls (for example, crm).

minLength1

tools: Array[{ name, type, defer_loading, 3 more} | CustomTool { name, type, defer_loading, 2 more } ]

The function/custom tools available inside this namespace.

One of the following:

class Function { name, type, defer_loading, 3 more }

maxLength128

minLength1

type: :function

defer_loading: bool

Whether this function should be deferred and discovered via tool search.

description: String

parameters: untyped

strict: bool

class CustomTool { name, type, defer_loading, 2 more }

A custom tool that processes input using a specified format. Learn more about custom tools

The name of the custom tool, used to identify it in tool calls.

type: :custom

The type of the custom tool. Always custom.

defer_loading: bool

Whether this tool should be deferred and discovered via tool search.

description: String

Optional description of the custom tool, used to provide more context.

format_: CustomToolInputFormat

The input format for the custom tool. Default is unconstrained text.

One of the following:

class Text { type }

Unconstrained free-form text.

type: :text

Unconstrained text format. Always text.

class Grammar { definition, syntax, type }

A grammar defined by the user.

definition: String

The grammar definition.

syntax: :lark | :regex

The syntax of the grammar definition. One of lark or regex.

One of the following:

:lark

:regex

type: :grammar

Grammar format. Always grammar.

type: :namespace

The type of the tool. Always namespace.

class ToolSearchTool { type, description, execution, parameters }

Hosted or BYOT tool search configuration for deferred tools.

type: :tool_search

The type of the tool. Always tool_search.

description: String

Description shown to the model for a client-executed tool search tool.

execution: :server | :client

Whether tool search is executed by the server or by the client.

One of the following:

:server

:client

parameters: untyped

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool { type, search_content_types, search_context_size, user_location }

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

type: :web_search_preview | :web_search_preview_2025_03_11

The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.

One of the following:

:web_search_preview

:web_search_preview_2025_03_11

search_content_types: Array[:text | :image]

One of the following:

:text

:image

search_context_size: :low | :medium | :high

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

One of the following:

:low

:medium

:high

user_location: { type, city, country, 2 more}

The user's location.

type: :approximate

The type of location approximation. Always approximate.

city: String

Free text input for the city of the user, e.g. San Francisco.

country: String

The two-letter ISO country code of the user, e.g. US.

region: String

Free text input for the region of the user, e.g. California.

timezone: String

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool { type }

Allows the assistant to create, delete, or update files using unified diffs.

type: :apply_patch

The type of the tool. Always apply_patch.

type: :tool_search_output

The type of the item. Always tool_search_output.

created_by: String

The identifier of the actor that created the item.

class ResponseReasoningItem { id, summary, type, 3 more }

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

id: String

The unique identifier of the reasoning content.

summary: Array[{ text, type}]

Reasoning summary content.

text: String

A summary of the reasoning output from the model so far.

type: :summary_text

The type of the object. Always summary_text.

type: :reasoning

The type of the object. Always reasoning.

content: Array[{ text, type}]

Reasoning text content.

text: String

The reasoning text from the model.

type: :reasoning_text

The type of the reasoning text. Always reasoning_text.

encrypted_content: String

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

status: :in_progress | :completed | :incomplete

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

:in_progress

:completed

:incomplete

class ResponseCompactionItem { id, encrypted_content, type, created_by }

A compaction item generated by the v1/responses/compact API.

id: String

The unique ID of the compaction item.

encrypted_content: String

The encrypted content that was produced by compaction.

type: :compaction

The type of the item. Always compaction.

created_by: String

The identifier of the actor that created the item.

class ResponseCodeInterpreterToolCall { id, code, container_id, 3 more }

A tool call to run code.

id: String

The unique ID of the code interpreter tool call.

code: String

The code to run, or null if not available.

container_id: String

The ID of the container used to run the code.

outputs: Array[{ logs, type} | { type, url}]

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs { logs, type }

The logs output from the code interpreter.

logs: String

The logs output from the code interpreter.

type: :logs

The type of the output. Always logs.

class Image { type, url }

The image output from the code interpreter.

type: :image

The type of the output. Always image.

url: String

The URL of the image output from the code interpreter.

status: :in_progress | :completed | :incomplete | 2 more

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

:in_progress

:completed

:incomplete

:interpreting

:failed

type: :code_interpreter_call

The type of the code interpreter tool call. Always code_interpreter_call.

class LocalShellCall { id, action, call_id, 2 more }

A tool call to run a command on the local shell.

id: String

The unique ID of the local shell call.

action: { command, env, type, 3 more}

Execute a shell command on the server.

command: Array[String]

The command to run.

env: Hash[Symbol, String]

Environment variables to set for the command.

type: :exec

The type of the local shell action. Always exec.

timeout_ms: Integer

Optional timeout in milliseconds for the command.

user: String

Optional user to run the command as.

working_directory: String

Optional working directory to run the command in.

call_id: String

The unique ID of the local shell tool call generated by the model.

status: :in_progress | :completed | :incomplete

The status of the local shell call.

One of the following:

:in_progress

:completed

:incomplete

type: :local_shell_call

The type of the local shell call. Always local_shell_call.

class LocalShellCallOutput { id, output, type, status }

The output of a local shell tool call.

id: String

The unique ID of the local shell tool call generated by the model.

output: String

A JSON string of the output of the local shell tool call.

type: :local_shell_call_output

The type of the local shell tool call output. Always local_shell_call_output.

status: :in_progress | :completed | :incomplete

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

:in_progress

:completed

:incomplete

class ResponseFunctionShellToolCall { id, action, call_id, 4 more }

A tool call that executes one or more shell commands in a managed environment.

id: String

The unique ID of the shell tool call. Populated when this item is returned via API.

action: { commands, max_output_length, timeout_ms}

The shell commands and limits that describe how to run the tool call.

commands: Array[String]

max_output_length: Integer

Optional maximum number of characters to return from each command.

timeout_ms: Integer

Optional timeout in milliseconds for the commands.

call_id: String

The unique ID of the shell tool call generated by the model.

environment: ResponseLocalEnvironment { type } | ResponseContainerReference { container_id, type }

Represents the use of a local environment to perform shell actions.

One of the following:

class ResponseLocalEnvironment { type }

Represents the use of a local environment to perform shell actions.

type: :local

The environment type. Always local.

class ResponseContainerReference { container_id, type }

Represents a container created with /v1/containers.

container_id: String

type: :container_reference

The environment type. Always container_reference.

status: :in_progress | :completed | :incomplete

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

:in_progress

:completed

:incomplete

type: :shell_call

The type of the item. Always shell_call.

created_by: String

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput { id, call_id, max_output_length, 4 more }

The output of a shell tool call that was emitted.

id: String

The unique ID of the shell call output. Populated when this item is returned via API.

call_id: String

The unique ID of the shell tool call generated by the model.

max_output_length: Integer

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

output: Array[{ outcome, stderr, stdout, created_by}]

An array of shell call output contents

outcome: { type} | { exit_code, type}

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

class Timeout { type }

Indicates that the shell call exceeded its configured time limit.

type: :timeout

The outcome type. Always timeout.

class Exit { exit_code, type }

Indicates that the shell commands finished and returned an exit code.

exit_code: Integer

Exit code from the shell process.

type: :exit

The outcome type. Always exit.

stderr: String

The standard error output that was captured.

stdout: String

The standard output that was captured.

created_by: String

The identifier of the actor that created the item.

status: :in_progress | :completed | :incomplete

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

:in_progress

:completed

:incomplete

type: :shell_call_output

The type of the shell call output. Always shell_call_output.

created_by: String

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall { id, call_id, operation, 3 more }

A tool call that applies file diffs by creating, deleting, or updating files.

id: String

The unique ID of the apply patch tool call. Populated when this item is returned via API.

call_id: String

The unique ID of the apply patch tool call generated by the model.

operation: { diff, path, type} | { path, type} | { diff, path, type}

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile { diff, path, type }

Instruction describing how to create a file via the apply_patch tool.

diff: String

Diff to apply.

path: String

Path of the file to create.

type: :create_file

Create a new file with the provided diff.

class DeleteFile { path, type }

Instruction describing how to delete a file via the apply_patch tool.

path: String

Path of the file to delete.

type: :delete_file

Delete the specified file.

class UpdateFile { diff, path, type }

Instruction describing how to update a file via the apply_patch tool.

diff: String

Diff to apply.

path: String

Path of the file to update.

type: :update_file

Update an existing file with the provided diff.

status: :in_progress | :completed

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

:in_progress

:completed

type: :apply_patch_call

The type of the item. Always apply_patch_call.

created_by: String

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput { id, call_id, status, 3 more }

The output emitted by an apply patch tool call.

id: String

The unique ID of the apply patch tool call output. Populated when this item is returned via API.

call_id: String

The unique ID of the apply patch tool call generated by the model.

status: :completed | :failed

The status of the apply patch tool call output. One of completed or failed.

One of the following:

:completed

:failed

type: :apply_patch_call_output

The type of the item. Always apply_patch_call_output.

created_by: String

The ID of the entity that created this tool call output.

output: String

Optional textual output returned by the apply patch tool.

class McpListTools { id, server_label, tools, 2 more }

A list of tools available on an MCP server.

id: String

The unique ID of the list.

server_label: String

The label of the MCP server.

tools: Array[{ input_schema, name, annotations, description}]

The tools available on the server.

input_schema: untyped

The JSON schema describing the tool's input.

The name of the tool.

annotations: untyped

Additional annotations about the tool.

description: String

The description of the tool.

type: :mcp_list_tools

The type of the item. Always mcp_list_tools.

error: String

Error message if the server could not list tools.

class McpApprovalRequest { id, arguments, name, 2 more }

A request for human approval of a tool invocation.

id: String

The unique ID of the approval request.

arguments: String

A JSON string of arguments for the tool.

The name of the tool to run.

server_label: String

The label of the MCP server making the request.

type: :mcp_approval_request

The type of the item. Always mcp_approval_request.

class McpApprovalResponse { id, approval_request_id, approve, 2 more }

A response to an MCP approval request.

id: String

The unique ID of the approval response

approval_request_id: String

The ID of the approval request being answered.

approve: bool

Whether the request was approved.

type: :mcp_approval_response

The type of the item. Always mcp_approval_response.

reason: String

Optional reason for the decision.

class McpCall { id, arguments, name, 6 more }

An invocation of a tool on an MCP server.

id: String

The unique ID of the tool call.

arguments: String

A JSON string of the arguments passed to the tool.

The name of the tool that was run.

server_label: String

The label of the MCP server running the tool.

type: :mcp_call

The type of the item. Always mcp_call.

approval_request_id: String

Unique identifier for the MCP tool call approval request. Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.

error: String

The error from the tool call, if any.

output: String

The output from the tool call.

status: :in_progress | :completed | :incomplete | 2 more

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

:in_progress

:completed

:incomplete

:calling

:failed

class ResponseCustomToolCall { call_id, input, name, 3 more }

A call to a custom tool created by the model.

call_id: String

An identifier used to map this custom tool call to a tool call output.

input: String

The input for the custom tool call generated by the model.

The name of the custom tool being called.

type: :custom_tool_call

The type of the custom tool call. Always custom_tool_call.

id: String

The unique ID of the custom tool call in the OpenAI platform.

namespace: String

The namespace of the custom tool being called.

class ResponseCustomToolCallOutput { call_id, output, type, id }

The output of a custom tool call from your code, being sent back to the model.

call_id: String

The call ID, used to map this custom tool call output to a custom tool call.

output: String | Array[ResponseInputText { text, type } | ResponseInputImage { detail, type, file_id, image_url } | ResponseInputFile { type, file_data, file_id, 2 more } ]

The output from the custom tool call generated by your code. Can be a string or an list of output content.

One of the following:

String

A string of the output of the custom tool call.

Array[ResponseInputText { text, type } | ResponseInputImage { detail, type, file_id, image_url } | ResponseInputFile { type, file_data, file_id, 2 more } ]

Text, image, or file output of the custom tool call.

One of the following:

class ResponseInputText { text, type }

A text input to the model.

text: String

The text input to the model.

type: :input_text

The type of the input item. Always input_text.

class ResponseInputImage { detail, type, file_id, image_url }

An image input to the model. Learn about image inputs.

detail: :low | :high | :auto | :original

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

One of the following:

:low

:high

:auto

:original

type: :input_image

The type of the input item. Always input_image.

file_id: String

The ID of the file to be sent to the model.

image_url: String

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ResponseInputFile { type, file_data, file_id, 2 more }

A file input to the model.

type: :input_file

The type of the input item. Always input_file.

file_data: String

The content of the file to be sent to the model.

file_id: String

The ID of the file to be sent to the model.

file_url: String

The URL of the file to be sent to the model.

filename: String

The name of the file to be sent to the model.

type: :custom_tool_call_output

The type of the custom tool call output. Always custom_tool_call_output.

id: String

The unique ID of the custom tool call output in the OpenAI platform.

List items

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.conversations.items.list("conv_123")

puts(page)

{
  "object": "list",
  "data": [
    {
      "type": "message",
      "id": "msg_abc",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "Hello!"}
      ]
    }
  ],
  "first_id": "msg_abc",
  "last_id": "msg_abc",
  "has_more": false
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "type": "message",
      "id": "msg_abc",
      "status": "completed",
      "role": "user",
      "content": [
        {"type": "input_text", "text": "Hello!"}
      ]
    }
  ],
  "first_id": "msg_abc",
  "last_id": "msg_abc",
  "has_more": false
}

Suggested

List items

ParametersExpand Collapse

ReturnsExpand Collapse

List items

Returns Examples