Create items

conversations.items.create(conversation_id, **kwargs) -> ConversationItemList { data, first_id, has_more, 2 more }

POST/conversations/{conversation_id}/items

Create items in a conversation with the given ID.

ParametersExpand Collapse

conversation_id: String

items: Array[ResponseInputItem]

The items to add to the conversation. You may add up to 20 items at a time.

Accepts one of the following:

class EasyInputMessage { content, role, type }

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

content: String | ResponseInputMessageContentList { , , }

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

Accepts one of the following:

String

A text input to the model.

Array[ResponseInputContent]

A list of one or many input items to the model, containing different content types.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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.

role: :user | :assistant | :system | :developer

The role of the message input. One of user, assistant, system, or developer.

Accepts one of the following:

:user

:assistant

:system

:developer

type: :message

The type of the message input. Always message.

class Message { content, role, status, type }

content: ResponseInputMessageContentList { , , }

A list of one or many input items to the model, containing different content types.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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.

role: :user | :system | :developer

The role of the message input. One of user, system, or developer.

Accepts one of the following:

:user

:system

:developer

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

type: :message

The type of the message input. Always set to message.

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

An output message from the model.

id: String

The unique ID of the output message.

content: Array[ResponseOutputText { annotations, text, type, logprobs } | ResponseOutputRefusal { refusal, type } ]

The content of the output message.

Accepts one of the following:

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.

Accepts 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 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.

role: :assistant

The role of the output message. Always assistant.

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

type: :message

The type of the output message. Always message.

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,

Accepts 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.

Accepts 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 ResponseComputerToolCall { id, action, call_id, 3 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.

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

A click action.

Accepts one of the following:

class Click { button, type, x, y_ }

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.

Accepts 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.

class DoubleClick { type, x, y_ }

A double click action.

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 }

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.

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_ }

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.

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, 2 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.

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.

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.

Accepts one of the following:

:in_progress

:completed

:incomplete

type: :computer_call

The type of the computer call. Always computer_call.

class ComputerCallOutput { call_id, output, type, 3 more }

The output of a computer tool call.

call_id: String

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

maxLength64

minLength1

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.

type: :computer_call_output

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

id: String

The ID of the computer tool 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.

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

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).

Accepts 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.

Accepts 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 ResponseFunctionToolCall { arguments, call_id, name, 3 more }

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

arguments: String

A JSON string of the arguments to pass to the function.

call_id: String

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

The name of the function to run.

type: :function_call

The type of the function tool call. Always function_call.

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.

Accepts one of the following:

:in_progress

:completed

:incomplete

class FunctionCallOutput { call_id, output, type, 2 more }

The output of a function tool call.

call_id: String

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

maxLength64

minLength1

output: String | ResponseFunctionCallOutputItemList { , , }

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

Accepts one of the following:

String

A JSON string of the output of the function tool call.

Array[ResponseFunctionCallOutputItem]

An array of content outputs (text, image, file) for the function tool call.

Accepts one of the following:

class ResponseInputTextContent { text, type }

A text input to the model.

text: String

The text input to the model.

maxLength10485760

type: :input_text

The type of the input item. Always input_text.

class ResponseInputImageContent { type, detail, file_id, image_url }

An image input to the model. Learn about image inputs

type: :input_image

The type of the input item. Always input_image.

detail: :low | :high | :auto

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

Accepts one of the following:

:low

:high

:auto

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.

maxLength20971520

class ResponseInputFileContent { 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 base64-encoded data of the file to be sent to the model.

maxLength33554432

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: :function_call_output

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

id: String

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

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

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.

Accepts one of the following:

:in_progress

:completed

:incomplete

class ResponseCompactionItemParam { encrypted_content, type, id }

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

encrypted_content: String

The encrypted content of the compaction summary.

maxLength10485760

type: :compaction

The type of the item. Always compaction.

id: String

The ID of the compaction item.

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.

Accepts 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 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.

Accepts 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.

Accepts 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.

Accepts 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.

Accepts one of the following:

:in_progress

:completed

:incomplete

class ShellCall { action, call_id, type, 2 more }

A tool representing a request to execute one or more shell commands.

action: { commands, max_output_length, timeout_ms}

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

commands: Array[String]

Ordered shell commands for the execution environment to run.

max_output_length: Integer

Maximum number of UTF-8 characters to capture from combined stdout and stderr output.

timeout_ms: Integer

Maximum wall-clock time in milliseconds to allow the shell commands to run.

call_id: String

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

maxLength64

minLength1

type: :shell_call

The type of the item. Always shell_call.

id: String

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

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

class ShellCallOutput { call_id, output, type, 3 more }

The streamed output items emitted by a shell tool call.

call_id: String

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

maxLength64

minLength1

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

Captured chunks of stdout and stderr output, along with their associated outcomes.

outcome: { type} | { exit_code, type}

The exit or timeout outcome associated with this shell call.

Accepts 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

The exit code returned by the shell process.

type: :exit

The outcome type. Always exit.

stderr: String

Captured stderr output for the shell call.

maxLength10485760

stdout: String

Captured stdout output for the shell call.

maxLength10485760

type: :shell_call_output

The type of the item. Always shell_call_output.

id: String

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

max_output_length: Integer

The maximum number of UTF-8 characters captured for this shell call's combined output.

status: :in_progress | :completed | :incomplete

The status of the shell call output.

Accepts one of the following:

:in_progress

:completed

:incomplete

class ApplyPatchCall { call_id, operation, status, 2 more }

A tool call representing a request to create, delete, or update files using diff patches.

call_id: String

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

maxLength64

minLength1

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

The specific create, delete, or update instruction for the apply_patch tool call.

Accepts one of the following:

class CreateFile { diff, path, type }

Instruction for creating a new file via the apply_patch tool.

diff: String

Unified diff content to apply when creating the file.

maxLength10485760

path: String

Path of the file to create relative to the workspace root.

minLength1

type: :create_file

The operation type. Always create_file.

class DeleteFile { path, type }

Instruction for deleting an existing file via the apply_patch tool.

path: String

Path of the file to delete relative to the workspace root.

minLength1

type: :delete_file

The operation type. Always delete_file.

class UpdateFile { diff, path, type }

Instruction for updating an existing file via the apply_patch tool.

diff: String

Unified diff content to apply to the existing file.

maxLength10485760

path: String

Path of the file to update relative to the workspace root.

minLength1

type: :update_file

The operation type. Always update_file.

status: :in_progress | :completed

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

Accepts one of the following:

:in_progress

:completed

type: :apply_patch_call

The type of the item. Always apply_patch_call.

id: String

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

class ApplyPatchCallOutput { call_id, status, type, 2 more }

The streamed output emitted by an apply patch tool call.

call_id: String

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

maxLength64

minLength1

status: :completed | :failed

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

Accepts one of the following:

:completed

:failed

type: :apply_patch_call_output

The type of the item. Always apply_patch_call_output.

id: String

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

output: String

Optional human-readable log text from the apply patch tool (e.g., patch results or errors).

maxLength10485760

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 { approval_request_id, approve, type, 2 more }

A response to an MCP approval request.

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.

id: String

The unique ID of the 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.

Accepts one of the following:

:in_progress

:completed

:incomplete

:calling

:failed

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.

Accepts 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.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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.

class ResponseCustomToolCall { call_id, input, name, 2 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.

class ItemReference { id, type }

An internal identifier for an item to reference.

id: String

The ID of the item to reference.

type: :item_reference

The type of item to reference. Always item_reference.

include: Array[ResponseIncludable]

Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.

Accepts one of the following:

:"file_search_call.results"

:"web_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"

ReturnsExpand Collapse

class ConversationItemList { data, first_id, has_more, 2 more }

A list of Conversation items.

data: Array[ConversationItem]

A list of conversation items.

Accepts 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

Accepts 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.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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 { file_id, image_url, type }

A screenshot of a computer.

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.

Accepts 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.

Accepts one of the following:

:in_progress

:completed

:incomplete

type: :message

The type of the message. Always set to message.

class ResponseFunctionToolCallItem { id }

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.

class ResponseFunctionToolCallOutputItem { id, call_id, output, 2 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.

Accepts 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.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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: :function_call_output

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

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

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,

Accepts 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]

Accepts 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).

Accepts 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.

Accepts 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.

Accepts 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, action, call_id, 3 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.

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

A click action.

Accepts one of the following:

class Click { button, type, x, y_ }

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.

Accepts 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.

class DoubleClick { type, x, y_ }

A double click action.

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 }

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.

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_ }

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.

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, 2 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.

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.

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.

Accepts one of the following:

:in_progress

:completed

:incomplete

type: :computer_call

The type of the computer call. Always computer_call.

class ResponseComputerToolCallOutputItem { id, call_id, output, 3 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.

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.

status: :in_progress | :completed | :incomplete

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

Accepts one of the following:

:in_progress

:completed

:incomplete

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

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.

Accepts one of the following:

:in_progress

:completed

:incomplete

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.

Accepts 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.

Accepts 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.

Accepts 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.

Accepts one of the following:

:in_progress

:completed

:incomplete

class ResponseFunctionShellToolCall { id, action, call_id, 3 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.

status: :in_progress | :completed | :incomplete

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

Accepts 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.

Accepts 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.

Accepts 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.

Accepts 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.

Accepts 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.

Accepts 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.

Accepts one of the following:

:in_progress

:completed

:incomplete

:calling

:failed

class ResponseCustomToolCall { call_id, input, name, 2 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.

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.

Accepts 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.

Accepts 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

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

Accepts one of the following:

:low

:high

:auto

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.

first_id: String

The ID of the first item in the list.

has_more: bool

Whether there are more items available.

last_id: String

The ID of the last item in the list.

object: :list

The type of object returned, must be list.

Create items

require "openai"

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

conversation_item_list = openai.conversations.items.create("conv_123", items: [{content: "string", role: :user, type: :message}])

puts(conversation_item_list)

{
  "data": [
    {
      "id": "id",
      "content": [
        {
          "text": "text",
          "type": "input_text"
        }
      ],
      "role": "unknown",
      "status": "in_progress",
      "type": "message"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "content": [
        {
          "text": "text",
          "type": "input_text"
        }
      ],
      "role": "unknown",
      "status": "in_progress",
      "type": "message"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Search the API docs

Getting Started

Using Codex

Configuration

Administration

Automation

Learn

Releases

Categories

Topics

Create items

ParametersExpand Collapse

ReturnsExpand Collapse

Create items

Returns Examples