List Input Items

GET /responses/{response_id}/input_items

Returns a list of input items for a given response.

cURL

curl --request GET \
  --url https://api.portkey.ai/v1/responses/{response_id}/input_items \
  --header 'x-portkey-api-key: <api-key>'

import requests

url = "https://api.portkey.ai/v1/responses/{response_id}/input_items"

headers = {"x-portkey-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-portkey-api-key': '<api-key>'}};

fetch('https://api.portkey.ai/v1/responses/{response_id}/input_items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.portkey.ai/v1/responses/{response_id}/input_items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-portkey-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.portkey.ai/v1/responses/{response_id}/input_items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-portkey-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.portkey.ai/v1/responses/{response_id}/input_items")
  .header("x-portkey-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/responses/{response_id}/input_items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-portkey-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "object": "list",
  "data": [
    {
      "content": [
        {
          "type": "input_text",
          "text": "<string>"
        }
      ],
      "id": "<string>",
      "type": "message"
    }
  ],
  "has_more": true,
  "first_id": "<string>",
  "last_id": "<string>"
}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

response_id · string · required

The ID of the response to retrieve input items for.

Query Parameters

limit · integer · default: 20

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

order · enum<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.

Available options: asc, 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.

Response

200 - application/json

OK

A list of Response items.

object · enum<string> · required

The type of object returned, must be list.

Available options: list

data · (Input message · object | Output message · object | File search tool call · object | Computer tool call · object | Computer tool call output · object | Web search tool call · object | Function tool call · object | Function tool call output · object)[] · required

A list of items used to generate this response.

Content item used to generate a response.

Input message

Output message

File search tool call

Computer tool call

Computer tool call output

Web search tool call

Function tool call

Function tool call output

Show child attributes

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.