cURL
curl --request GET \
--url https://api.helicone.ai/v1/request/{requestId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.helicone.ai/v1/request/{requestId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helicone.ai/v1/request/{requestId}', 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.helicone.ai/v1/request/{requestId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.helicone.ai/v1/request/{requestId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.helicone.ai/v1/request/{requestId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helicone.ai/v1/request/{requestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"response_id": "<string>",
"response_created_at": "<string>",
"response_status": 123,
"response_model": "<string>",
"request_id": "<string>",
"request_created_at": "<string>",
"request_body": "<unknown>",
"request_path": "<string>",
"request_user_id": "<string>",
"request_properties": {},
"request_model": "<string>",
"model_override": "<string>",
"helicone_user": "<string>",
"delay_ms": 123,
"time_to_first_token": 123,
"total_tokens": 123,
"prompt_tokens": 123,
"prompt_cache_write_tokens": 123,
"prompt_cache_read_tokens": 123,
"completion_tokens": 123,
"reasoning_tokens": 123,
"prompt_audio_tokens": 123,
"completion_audio_tokens": 123,
"cost": 123,
"prompt_id": "<string>",
"prompt_version": "<string>",
"llmSchema": {
"request": {
"provider": "<string>",
"model": "<string>",
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"title": "<string>",
"url": "<string>",
"type": "url_citation",
"content": "<string>"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": "<array>",
"idx": 123,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>"
}
],
"prompt": "<string>",
"instructions": "<string>",
"max_tokens": 123,
"temperature": 123,
"top_p": 123,
"seed": 123,
"stream": true,
"presence_penalty": 123,
"frequency_penalty": 123,
"stop": [
"<string>"
],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {},
"strict": true
}
],
"parallel_tool_calls": true,
"tool_choice": {
"name": "<string>"
},
"response_format": {
"type": "<string>",
"json_schema": "<unknown>"
},
"toolDetails": {
"_type": "tool",
"toolName": "<string>",
"input": "<unknown>"
},
"vectorDBDetails": {
"_type": "vector_db",
"text": "<string>",
"vector": [
123
],
"topK": 123,
"filter": {},
"databaseName": "<string>"
},
"dataDetails": {
"_type": "data",
"name": "<string>",
"meta": {}
},
"input": "<string>",
"n": 123,
"size": "<string>",
"quality": "<string>"
},
"response": {
"dataDetailsResponse": {
"name": "<string>",
"_type": "data",
"metadata": {
"timestamp": "<string>"
},
"message": "<string>",
"status": "<string>"
},
"vectorDBDetailsResponse": {
"_type": "vector_db",
"metadata": {
"timestamp": "<string>",
"destination_parsed": true,
"destination": "<string>"
},
"message": "<string>",
"status": "<string>",
"actualSimilarity": 123,
"similarityThreshold": 123
},
"toolDetailsResponse": {
"toolName": "<string>",
"_type": "tool",
"metadata": {
"timestamp": "<string>"
},
"tips": [
"<string>"
],
"message": "<string>",
"status": "<string>"
},
"error": {
"heliconeMessage": "<unknown>"
},
"model": "<string>",
"instructions": "<string>",
"responses": [
{
"contentArray": "<array>",
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"idx": 123,
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"text": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"title": "<string>",
"url": "<string>",
"type": "url_citation",
"content": "<string>"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": "<array>",
"idx": 123,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>"
}
]
}
},
"country_code": "<string>",
"asset_ids": [
"<string>"
],
"asset_urls": {},
"scores": {},
"properties": {},
"assets": [
"<string>"
],
"target_url": "<string>",
"model": "<string>",
"cache_reference_id": "<string>",
"cache_enabled": true,
"ai_gateway_body_mapping": "<string>",
"response_body": "<unknown>",
"feedback_created_at": "<string>",
"feedback_id": "<string>",
"feedback_rating": true,
"signed_body_url": "<string>",
"costUSD": 123,
"updated_at": "<string>",
"request_referrer": "<string>",
"storage_location": "<string>"
},
"error": null
}Request
Get Single Request
Retrieve a single request visible in the request table at Helicone.
GET
/
v1
/
request
/
{requestId}
cURL
curl --request GET \
--url https://api.helicone.ai/v1/request/{requestId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.helicone.ai/v1/request/{requestId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helicone.ai/v1/request/{requestId}', 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.helicone.ai/v1/request/{requestId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.helicone.ai/v1/request/{requestId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.helicone.ai/v1/request/{requestId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helicone.ai/v1/request/{requestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"response_id": "<string>",
"response_created_at": "<string>",
"response_status": 123,
"response_model": "<string>",
"request_id": "<string>",
"request_created_at": "<string>",
"request_body": "<unknown>",
"request_path": "<string>",
"request_user_id": "<string>",
"request_properties": {},
"request_model": "<string>",
"model_override": "<string>",
"helicone_user": "<string>",
"delay_ms": 123,
"time_to_first_token": 123,
"total_tokens": 123,
"prompt_tokens": 123,
"prompt_cache_write_tokens": 123,
"prompt_cache_read_tokens": 123,
"completion_tokens": 123,
"reasoning_tokens": 123,
"prompt_audio_tokens": 123,
"completion_audio_tokens": 123,
"cost": 123,
"prompt_id": "<string>",
"prompt_version": "<string>",
"llmSchema": {
"request": {
"provider": "<string>",
"model": "<string>",
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"title": "<string>",
"url": "<string>",
"type": "url_citation",
"content": "<string>"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": "<array>",
"idx": 123,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>"
}
],
"prompt": "<string>",
"instructions": "<string>",
"max_tokens": 123,
"temperature": 123,
"top_p": 123,
"seed": 123,
"stream": true,
"presence_penalty": 123,
"frequency_penalty": 123,
"stop": [
"<string>"
],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {},
"strict": true
}
],
"parallel_tool_calls": true,
"tool_choice": {
"name": "<string>"
},
"response_format": {
"type": "<string>",
"json_schema": "<unknown>"
},
"toolDetails": {
"_type": "tool",
"toolName": "<string>",
"input": "<unknown>"
},
"vectorDBDetails": {
"_type": "vector_db",
"text": "<string>",
"vector": [
123
],
"topK": 123,
"filter": {},
"databaseName": "<string>"
},
"dataDetails": {
"_type": "data",
"name": "<string>",
"meta": {}
},
"input": "<string>",
"n": 123,
"size": "<string>",
"quality": "<string>"
},
"response": {
"dataDetailsResponse": {
"name": "<string>",
"_type": "data",
"metadata": {
"timestamp": "<string>"
},
"message": "<string>",
"status": "<string>"
},
"vectorDBDetailsResponse": {
"_type": "vector_db",
"metadata": {
"timestamp": "<string>",
"destination_parsed": true,
"destination": "<string>"
},
"message": "<string>",
"status": "<string>",
"actualSimilarity": 123,
"similarityThreshold": 123
},
"toolDetailsResponse": {
"toolName": "<string>",
"_type": "tool",
"metadata": {
"timestamp": "<string>"
},
"tips": [
"<string>"
],
"message": "<string>",
"status": "<string>"
},
"error": {
"heliconeMessage": "<unknown>"
},
"model": "<string>",
"instructions": "<string>",
"responses": [
{
"contentArray": "<array>",
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"idx": 123,
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"text": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"title": "<string>",
"url": "<string>",
"type": "url_citation",
"content": "<string>"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": "<array>",
"idx": 123,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {},
"id": "<string>"
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>"
}
]
}
},
"country_code": "<string>",
"asset_ids": [
"<string>"
],
"asset_urls": {},
"scores": {},
"properties": {},
"assets": [
"<string>"
],
"target_url": "<string>",
"model": "<string>",
"cache_reference_id": "<string>",
"cache_enabled": true,
"ai_gateway_body_mapping": "<string>",
"response_body": "<unknown>",
"feedback_created_at": "<string>",
"feedback_id": "<string>",
"feedback_rating": true,
"signed_body_url": "<string>",
"costUSD": 123,
"updated_at": "<string>",
"request_referrer": "<string>",
"storage_location": "<string>"
},
"error": null
}For users in the European Union: Please use
eu.api.helicone.ai instead of
api.helicone.ai.Authorizations
Bearer token authentication. Format: 'Bearer YOUR_API_KEY'
Path Parameters
Query Parameters
Was this page helpful?
⌘I