Returns a list of input items for a given response.

GET /responses/{response_id}/input_items

Api key auth

Path parameters

response_id string Required

The ID of the response to retrieve input items for.

Query parameters

limit integer

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

Default value is 20.
order string
The order to return the input items in. Default is asc.
- asc: Return the input items in ascending order.
- desc: Return the input items in descending order.
Values are asc or desc.
after string

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

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

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- object string Required
  
  The type of object returned, must be list.
  
  Value is list.
- data array[object] Required
  
  A list of items used to generate this response.
  
  Content item used to generate a response.
  
  Content item used to generate a response.
  
  One of:
  InputMessageResource object OutputMessage object FileSearchToolCall object ComputerToolCall object ComputerToolCallOutputResource object WebSearchToolCall object FunctionToolCallResource object FunctionToolCallOutputResource object
  
  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.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  The type of the message input. Always set to message.
  
  Value is message.
  
  role string Required
  
  The role of the message input. One of user, system, or developer.
  
  Values are user, system, or developer.
  
  status string
  
  The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
  
  Values are in_progress, completed, or incomplete.
  
  content array[object] Required
  
  A list of one or many input items to the model, containing different content types.
  
  One of:
  InputText object InputImage object InputFile object
  
  A text input to the model.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the input item. Always input_text.
  
  Value is input_text.
  
  text string Required
  
  The text input to the model.
  
  An image input to the model. Learn about image inputs.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the input item. Always input_image.
  
  Value is input_image.
  
  image_url string | null
  
  The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
  
  file_id string | null
  
  The ID of the file to be sent to the model.
  
  detail string Required
  
  The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
  
  Values are high, low, or auto. Default value is auto.
  
  A file input to the model.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the input item. Always input_file.
  
  Value is input_file.
  
  file_id string
  
  The ID of the file to be sent to the model.
  
  filename string
  
  The name of the file to be sent to the model.
  
  file_data string
  
  The content of the file to be sent to the model.
  
  id string Required
  
  The unique ID of the message input.
  
  An output message from the model.
  
  Hide attributes Show attributes
  
  id string Required
  
  The unique ID of the output message.
  
  type string Required Discriminator
  
  The type of the output message. Always message.
  
  Value is message.
  
  role string Required
  
  The role of the output message. Always assistant.
  
  Value is assistant.
  
  content array[object] Required
  
  The content of the output message.
  
  One of:
  OutputText object Refusal object
  
  A text output from the model.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the output text. Always output_text.
  
  Value is output_text.
  
  text string Required
  
  The text output from the model.
  
  annotations array[object] Required
  
  The annotations of the text output.
  
  One of:
  FileCitation object UrlCitation object FilePath object
  
  A citation to a file.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the file citation. Always file_citation.
  
  Value is file_citation.
  
  index integer Required
  
  The index of the file in the list of files.
  
  file_id string Required
  
  The ID of the file.
  
  A citation for a web resource used to generate a model response.
  
  Hide attributes Show attributes
  
  url string Required
  
  The URL of the web resource.
  
  title string Required
  
  The title of the web resource.
  
  type string Required
  
  The type of the URL citation. Always url_citation.
  
  Value is url_citation.
  
  start_index integer Required
  
  The index of the first character of the URL citation in the message.
  
  end_index integer Required
  
  The index of the last character of the URL citation in the message.
  
  A path to a file.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the file path. Always file_path.
  
  Value is file_path.
  
  file_id string Required
  
  The ID of the file.
  
  index integer Required
  
  The index of the file in the list of files.
  
  A refusal from the model.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the refusal. Always refusal.
  
  Value is refusal.
  
  refusal string Required
  
  The refusal explanationfrom the model.
  
  status string Required
  
  The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
  
  Values are in_progress, completed, or incomplete.
  
  The results of a file search tool call. See the file search guide for more information.
  
  Hide attributes Show attributes
  
  id string Required
  
  The unique ID of the file search tool call.
  
  type string Required Discriminator
  
  The type of the file search tool call. Always file_search_call.
  
  Value is file_search_call.
  
  status string Required
  
  The status of the file search tool call. One of in_progress, searching, incomplete or failed,
  
  Values are in_progress, searching, completed, incomplete, or failed.
  
  queries array[string] Required
  
  The queries used to search for files.
  
  results array[object] | null
  
  The results of the file search tool call.
  
  Hide results attributes Show results attributes object
  
  file_id string
  
  The unique ID of the file.
  
  text string
  
  The text that was retrieved from the file.
  
  filename string
  
  The name of the file.
  
  attributes object | null
  
  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.
  
  score number(float)
  
  The relevance score of the file - a value between 0 and 1.
  
  A tool call to a computer use tool. See the computer use guide for more information.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  The type of the computer call. Always computer_call.
  
  Value is computer_call. Default value is computer_call.
  
  id string Required
  
  The unique ID of the computer call.
  
  call_id string Required
  
  An identifier used when responding to the tool call with output.
  
  action object Required
  
  One of:
  Click object DoubleClick object Drag object KeyPress object Move object Screenshot object Scroll object Type object Wait object
  
  A click action.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a click action, this property is always set to click.
  
  Value is click. Default value is click.
  
  button string Required
  
  Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
  
  Values are left, right, wheel, back, or forward.
  
  x integer Required
  
  The x-coordinate where the click occurred.
  
  y integer Required
  
  The y-coordinate where the click occurred.
  
  A double click action.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a double click action, this property is always set to double_click.
  
  Value is double_click. Default value is double_click.
  
  x integer Required
  
  The x-coordinate where the double click occurred.
  
  y integer Required
  
  The y-coordinate where the double click occurred.
  
  A drag action.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a drag action, this property is always set to drag.
  
  Value is drag. Default value is drag.
  
  path array[object] Required
  
  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 } ]
  
  A series of x/y coordinate pairs in the drag path.
  
  Hide path attributes Show path attributes object
  
  x integer Required
  
  The x-coordinate.
  
  y integer Required
  
  The y-coordinate.
  
  A collection of keypresses the model would like to perform.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a keypress action, this property is always set to keypress.
  
  Value is keypress. Default value is keypress.
  
  keys array[string] Required
  
  The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.
  
  A mouse move action.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a move action, this property is always set to move.
  
  Value is move. Default value is move.
  
  x integer Required
  
  The x-coordinate to move to.
  
  y integer Required
  
  The y-coordinate to move to.
  
  A scroll action.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a scroll action, this property is always set to scroll.
  
  Value is scroll. Default value is scroll.
  
  x integer Required
  
  The x-coordinate where the scroll occurred.
  
  y integer Required
  
  The y-coordinate where the scroll occurred.
  
  scroll_x integer Required
  
  The horizontal scroll distance.
  
  scroll_y integer Required
  
  The vertical scroll distance.
  
  An action to type in text.
  
  Hide attributes Show attributes
  
  type string Required
  
  Specifies the event type. For a type action, this property is always set to type.
  
  Value is type. Default value is type.
  
  text string Required
  
  The text to type.
  
  pending_safety_checks array[object] Required
  
  The pending safety checks for the computer call.
  
  A pending safety check for the computer call.
  
  Hide pending_safety_checks attributes Show pending_safety_checks attributes object
  
  id string Required
  
  The ID of the pending safety check.
  
  code string Required
  
  The type of the pending safety check.
  
  message string Required
  
  Details about the pending safety check.
  
  status string Required
  
  The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
  
  Values are in_progress, completed, or incomplete.
  
  The output of a computer tool call.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  The type of the computer tool call output. Always computer_call_output.
  
  Value is computer_call_output. Default value is computer_call_output.
  
  id string Required
  
  The unique ID of the computer call tool output.
  
  call_id string Required
  
  The ID of the computer tool call that produced the output.
  
  acknowledged_safety_checks array[object]
  
  The safety checks reported by the API that have been acknowledged by the developer.
  
  A pending safety check for the computer call.
  
  Hide acknowledged_safety_checks attributes Show acknowledged_safety_checks attributes object
  
  id string Required
  
  The ID of the pending safety check.
  
  code string Required
  
  The type of the pending safety check.
  
  message string Required
  
  Details about the pending safety check.
  
  output object Required
  
  A computer screenshot image used with the computer use tool.
  
  Hide output attributes Show output attributes object
  
  type string Required
  
  Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
  
  Value is computer_screenshot. Default value is computer_screenshot.
  
  image_url string
  
  The URL of the screenshot image.
  
  file_id string
  
  The identifier of an uploaded file that contains the screenshot.
  
  status string
  
  The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
  
  Values are in_progress, completed, or incomplete.
  
  The results of a web search tool call. See the web search guide for more information.
  
  Hide attributes Show attributes
  
  id string Required
  
  The unique ID of the web search tool call.
  
  type string Required Discriminator
  
  The type of the web search tool call. Always web_search_call.
  
  Value is web_search_call.
  
  status string Required
  
  The status of the web search tool call.
  
  Values are in_progress, searching, completed, or failed.
  
  A tool call to run a function. See the function calling guide for more information.
  
  Hide attributes Show attributes
  
  id string Required
  
  The unique ID of the function tool call.
  
  type string Required Discriminator
  
  The type of the function tool call. Always function_call.
  
  Value is function_call.
  
  call_id string Required
  
  The unique ID of the function tool call generated by the model.
  
  name string Required
  
  The name of the function to run.
  
  arguments string Required
  
  A JSON string of the arguments to pass to the function.
  
  status string
  
  The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
  
  Values are in_progress, completed, or incomplete.
  
  The output of a function tool call.
  
  Hide attributes Show attributes
  
  id string Required
  
  The unique ID of the function call tool output.
  
  type string Required Discriminator
  
  The type of the function tool call output. Always function_call_output.
  
  Value is function_call_output.
  
  call_id string Required
  
  The unique ID of the function tool call generated by the model.
  
  output string Required
  
  A JSON string of the output of the function tool call.
  
  status string
  
  The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
  
  Values are in_progress, completed, or incomplete.
- has_more boolean Required
  
  Whether there are more items available.
- first_id string Required
  
  The ID of the first item in the list.
- last_id string Required
  
  The ID of the last item in the list.

GET /responses/{response_id}/input_items

curl \
 --request GET 'https://api.openai.com/v1/responses/{response_id}/input_items' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

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