Skip to main content
GET
/
api
/
public
/
v2
/
requests
/
{request_id}
Get Request
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/requests/{request_id} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.promptlayer.com/api/public/v2/requests/{request_id}"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/api/public/v2/requests/{request_id}', 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.promptlayer.com/api/public/v2/requests/{request_id}",
  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-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.promptlayer.com/api/public/v2/requests/{request_id}"

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

	req.Header.Add("X-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.promptlayer.com/api/public/v2/requests/{request_id}")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/requests/{request_id}")

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

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

response = http.request(request)
puts response.read_body
{
  "success": true,
  "prompt_blueprint": {
    "prompt_template": {
      "type": "chat",
      "messages": [
        {
          "role": "user",
          "content": [
            {
              "type": "text",
              "text": "Hello, world!"
            }
          ]
        }
      ]
    },
    "metadata": {
      "model": {
        "provider": "openai",
        "name": "gpt-4",
        "parameters": {}
      }
    },
    "inference_client_name": null
  },
  "request_id": 12345,
  "provider": "openai",
  "model": "gpt-4",
  "input_tokens": 12,
  "output_tokens": 25,
  "tokens": 37,
  "price": 0.00123,
  "request_start_time": "2024-04-03T20:57:25Z",
  "request_end_time": "2024-04-03T20:57:26Z",
  "latency_ms": 1000,
  "trace_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
Retrieve the full payload of a logged request by ID. The response includes a prompt blueprint, token usage, timing data, pricing, and an associated trace_id when tracing data is available.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
request_id
integer
required

The ID of the request to retrieve.

Required range: x >= 1

Response

Request log detail.

​
success
enum<boolean>
required
Available options:
true
​
prompt_blueprint
object
required

Provider-agnostic prompt blueprint that can be replayed.

​
request_id
integer
required
​
provider
string
​
model
string
​
input_tokens
integer
​
output_tokens
integer
​
tokens
integer
​
price
number
​
request_start_time
string<date-time>
​
request_end_time
string<date-time>
​
latency_ms
number
​
trace_id
string | null

Associated trace ID, if available.