Warning
For users in the European Union: Please use eu.api.helicone.ai instead of
api.helicone.ai.
Get Single Request
Retrieve a single request visible in the request table at Helicone.
1 min read
get/v1/request/{requestId}
Request example
curl --request GET \
--url https://api.helicone.ai/v1/request/{requestId} \
--header 'Authorization: <api-key>'Response
{
"data": {
"response_id": "<string>",
"response_created_at": "<string>",
"response_body": null,
"response_status": 1,
"response_model": "<string>",
"request_id": "<string>",
"request_created_at": "<string>",
"request_body": null,
"request_path": "<string>",
"request_user_id": "<string>",
"request_properties": {},
"request_model": "<string>",
"model_override": "<string>",
"helicone_user": "<string>",
"provider": "OPENAI",
"delay_ms": 1,
"time_to_first_token": 1,
"total_tokens": 1,
"prompt_tokens": 1,
"prompt_cache_write_tokens": 1,
"prompt_cache_read_tokens": 1,
"completion_tokens": 1,
"reasoning_tokens": 1,
"prompt_audio_tokens": 1,
"completion_audio_tokens": 1,
"cost": 1,
"prompt_id": "<string>",
"prompt_version": "<string>",
"feedback_created_at": "<string>",
"feedback_id": "<string>",
"feedback_rating": true,
"signed_body_url": "<string>",
"llmSchema": {
"request": {
"llm_type": "chat",
"provider": "<string>",
"model": "<string>",
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"content": "<string>",
"title": "<string>",
"url": "<string>",
"type": "url_citation"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": [
null
],
"idx": 1,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"type": "input_image",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"id": "<string>",
"name": "<string>",
"arguments": {}
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>",
"_type": "functionCall"
}
],
"prompt": "<string>",
"instructions": "<string>",
"max_tokens": 1,
"temperature": 1,
"top_p": 1,
"seed": 1,
"stream": true,
"presence_penalty": 1,
"frequency_penalty": 1,
"stop": [
"<string>"
],
"reasoning_effort": "minimal",
"verbosity": "low",
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {},
"strict": true
}
],
"parallel_tool_calls": true,
"tool_choice": {
"name": "<string>",
"type": "none"
},
"response_format": {
"json_schema": null,
"type": "<string>"
},
"toolDetails": {
"_type": "tool",
"toolName": "<string>",
"input": null
},
"vectorDBDetails": {
"_type": "vector_db",
"operation": "search",
"text": "<string>",
"vector": [
1
],
"topK": 1,
"filter": {},
"databaseName": "<string>"
},
"dataDetails": {
"_type": "data",
"name": "<string>",
"meta": {}
},
"input": "<string>",
"n": 1,
"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>"
},
"actualSimilarity": 1,
"similarityThreshold": 1,
"message": "<string>",
"status": "<string>"
},
"toolDetailsResponse": {
"toolName": "<string>",
"_type": "tool",
"metadata": {
"timestamp": "<string>"
},
"tips": [
"<string>"
],
"message": "<string>",
"status": "<string>"
},
"error": {
"heliconeMessage": null
},
"model": "<string>",
"instructions": "<string>",
"responses": [
{
"contentArray": [
null
],
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"idx": 1,
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"id": "<string>",
"name": "<string>",
"arguments": {}
}
],
"text": "<string>",
"type": "input_image",
"name": "<string>",
"role": "user",
"id": "<string>",
"_type": "functionCall"
}
],
"messages": [
{
"ending_event_id": "<string>",
"trigger_event_id": "<string>",
"start_timestamp": "<string>",
"annotations": [
{
"content": "<string>",
"title": "<string>",
"url": "<string>",
"type": "url_citation"
}
],
"reasoning": "<string>",
"deleted": true,
"contentArray": [
null
],
"idx": 1,
"detail": "<string>",
"filename": "<string>",
"file_id": "<string>",
"file_data": "<string>",
"type": "input_image",
"audio_data": "<string>",
"image_url": "<string>",
"timestamp": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"id": "<string>",
"name": "<string>",
"arguments": {}
}
],
"mime_type": "<string>",
"content": "<string>",
"name": "<string>",
"instruction": "<string>",
"role": "<string>",
"id": "<string>",
"_type": "functionCall"
}
]
}
},
"country_code": "<string>",
"asset_ids": [
"<string>"
],
"asset_urls": {},
"scores": {},
"costUSD": 1,
"properties": {},
"assets": [
"<string>"
],
"target_url": "<string>",
"model": "<string>",
"cache_reference_id": "<string>",
"cache_enabled": true,
"updated_at": "<string>",
"request_referrer": "<string>",
"ai_gateway_body_mapping": "<string>",
"storage_location": "<string>"
},
"error": null
}get/v1/request/{requestId}
Authorization
Bearer token authentication. Format: 'Bearer YOUR_API_KEY'
Path parameters
Query parameters
Default: false
Responses
application/json
200
Ok