GET
/
v1
/
request
/
{requestId}
cURL
curl --request GET \
  --url https://api.helicone.ai/v1/request/{requestId} \
  --header 'authorization: <api-key>'
{
  "data": {
    "response_id": "<string>",
    "response_created_at": "<string>",
    "response_body": "<any>",
    "response_status": 123,
    "response_model": "<string>",
    "request_id": "<string>",
    "request_created_at": "<string>",
    "request_body": "<any>",
    "request_path": "<string>",
    "request_user_id": "<string>",
    "request_properties": {},
    "request_model": "<string>",
    "model_override": "<string>",
    "helicone_user": "<string>",
    "provider": "OPENAI",
    "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,
    "prompt_audio_tokens": 123,
    "completion_audio_tokens": 123,
    "cost": 123,
    "prompt_id": "<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>",
            "deleted": true,
            "contentArray": [
              {}
            ],
            "idx": 123,
            "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": 123,
        "temperature": 123,
        "top_p": 123,
        "seed": 123,
        "stream": true,
        "presence_penalty": 123,
        "frequency_penalty": 123,
        "stop": [
          "<string>"
        ],
        "reasoning_effort": "low",
        "tools": [
          {
            "name": "<string>",
            "description": "<string>",
            "parameters": {}
          }
        ],
        "parallel_tool_calls": true,
        "tool_choice": {
          "name": "<string>",
          "type": "none"
        },
        "response_format": {
          "json_schema": "<any>",
          "type": "<string>"
        },
        "toolDetails": {
          "_type": "tool",
          "toolName": "<string>",
          "input": "<any>"
        },
        "vectorDBDetails": {
          "_type": "vector_db",
          "operation": "search",
          "text": "<string>",
          "vector": [
            123
          ],
          "topK": 123,
          "filter": {},
          "databaseName": "<string>"
        },
        "input": "<string>",
        "n": 123,
        "size": "<string>",
        "quality": "<string>"
      },
      "response": {
        "vectorDBDetailsResponse": {
          "_type": "vector_db",
          "metadata": {
            "timestamp": "<string>",
            "destination_parsed": true,
            "destination": "<string>"
          },
          "actualSimilarity": 123,
          "similarityThreshold": 123,
          "message": "<string>",
          "status": "<string>"
        },
        "toolDetailsResponse": {
          "toolName": "<string>",
          "_type": "tool",
          "metadata": {
            "timestamp": "<string>"
          },
          "tips": [
            "<string>"
          ],
          "message": "<string>",
          "status": "<string>"
        },
        "error": {
          "heliconeMessage": "<any>"
        },
        "model": "<string>",
        "instructions": "<string>",
        "responses": [
          {
            "contentArray": [
              {}
            ],
            "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": [
              {
                "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>",
            "deleted": true,
            "contentArray": [
              {}
            ],
            "idx": 123,
            "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": 123,
    "properties": {},
    "assets": [
      "<string>"
    ],
    "target_url": "<string>",
    "model": "<string>",
    "cache_reference_id": "<string>",
    "cache_enabled": true,
    "updated_at": "<string>"
  }
}

For users in the European Union: Please use eu.api.helicone.ai instead of api.helicone.ai.

Authorizations

​
authorization
string
header
required

Path Parameters

​
requestId
string
required

Query Parameters

​
includeBody
boolean
default:false

Response

200 - application/json

Ok

The response is of type object.