--- title: "GET /v1/request/{requestId}" method: GET path: "/v1/request/{requestId}" tags: ["Request"] --- # GET /v1/request/{requestId} `GET /v1/request/{requestId}` ## Path parameters - `requestId` string, required ## Query parameters - `includeBody` boolean ## Response `200` Ok - union - ResultSuccessHeliconeRequest - `data` HeliconeRequest, required - `response_id` string, nullable, required - `response_created_at` string, nullable, required - `response_body` unknown - `response_status` number, double, required - `response_model` string, nullable, required - `request_id` string, required - `request_created_at` string, required - `request_body` unknown, required - `request_path` string, required - `request_user_id` string, nullable, required - `request_properties` RecordStringString, required — Construct a type with a set of properties K of type T - `request_model` string, nullable, required - `model_override` string, nullable, required - `helicone_user` string, nullable, required - `provider` union, required - 'OPENAI' | 'ANTHROPIC' | 'AZURE' | 'LOCAL' | 'HELICONE' | 'AMDBARTEK' | 'ANYSCALE' | 'CLOUDFLARE' | '2YFV' | 'TOGETHER' | 'LEMONFOX' | 'FIREWORKS' | 'PERPLEXITY' | 'GOOGLE' | 'OPENROUTER' | 'WISDOMINANUTSHELL' | 'GROQ' | 'COHERE' | 'MISTRAL' | 'DEEPINFRA' | 'QSTASH' | 'FIRECRAWL' | 'AWS' | 'BEDROCK' | 'DEEPSEEK' | 'X' | 'AVIAN' | 'NEBIUS' | 'NOVITA' | 'OPENPIPE' | 'CHUTES' | 'LLAMA' | 'NVIDIA' | 'VERCEL' | 'CEREBRAS' | 'BASETEN' | 'CANOPYWAVE' - 'baseten' | 'anthropic' | 'azure' | 'bedrock' | 'canopywave' | 'cerebras' | 'chutes' | 'deepinfra' | 'deepseek' | 'fireworks' | 'google-ai-studio' | 'groq' | 'helicone' | 'mistral' | 'nebius' | 'novita' | 'openai' | 'openrouter' | 'perplexity' | 'vertex' | 'xai' - 'CUSTOM' - `delay_ms` number, double, nullable, required - `time_to_first_token` number, double, nullable, required - `total_tokens` number, double, nullable, required - `prompt_tokens` number, double, nullable, required - `prompt_cache_write_tokens` number, double, nullable, required - `prompt_cache_read_tokens` number, double, nullable, required - `completion_tokens` number, double, nullable, required - `reasoning_tokens` number, double, nullable, required - `prompt_audio_tokens` number, double, nullable, required - `completion_audio_tokens` number, double, nullable, required - `cost` number, double, nullable, required - `prompt_id` string, nullable, required - `prompt_version` string, nullable, required - `feedback_created_at` string, nullable - `feedback_id` string, nullable - `feedback_rating` boolean, nullable - `signed_body_url` string, nullable - `llmSchema` LlmSchema, required - `request` LLMRequestBody, required - `llm_type` 'chat' | 'completion' - `provider` string - `model` string - `messages` Message[], nullable - `ending_event_id` string - `trigger_event_id` string - `start_timestamp` string - `annotations` object[] - … - `reasoning` string - `deleted` boolean - `contentArray` Message[] - `idx` number, double - `detail` string - `filename` string - `file_id` string - `file_data` string - `type` 'input_image' | 'input_text' | 'input_file' - `audio_data` string - `image_url` string - `timestamp` string - `tool_call_id` string - `tool_calls` FunctionCall[] - … - `mime_type` string - `content` string - `name` string - `instruction` string - `role` union - … - `id` string - `_type` 'functionCall' | 'function' | 'image' | 'file' | 'message' | 'autoInput' | 'contentArray' | 'audio', required - `prompt` string, nullable - `instructions` string, nullable - `max_tokens` number, double, nullable - `temperature` number, double, nullable - `top_p` number, double, nullable - `seed` number, double, nullable - `stream` boolean, nullable - `presence_penalty` number, double, nullable - `frequency_penalty` number, double, nullable - `stop` union - string[] - string - `reasoning_effort` 'minimal' | 'low' | 'medium' | 'high' | 'null', nullable - `verbosity` 'low' | 'medium' | 'high' | 'null', nullable - `tools` Tool[] - `name` string, required - `description` string - `parameters` RecordStringAny — Construct a type with a set of properties K of type T - `strict` boolean - `parallel_tool_calls` boolean, nullable - `tool_choice` object - `name` string - `type` 'none' | 'auto' | 'any' | 'tool', required - `response_format` object - `json_schema` unknown - `type` string, required - `toolDetails` HeliconeEventTool - `_type` 'tool', required - `toolName` string, required - `input` unknown, required - `vectorDBDetails` HeliconeEventVectorDB - `_type` 'vector_db', required - `operation` 'search' | 'insert' | 'delete' | 'update', required - `text` string - `vector` number[] - `topK` number, double - `filter` object - `databaseName` string - `dataDetails` HeliconeEventData - `_type` 'data', required - `name` string, required - `meta` RecordStringAny — Construct a type with a set of properties K of type T - `input` union - string - string[] - `n` number, double, nullable - `size` string - `quality` string - `response` LLMResponseBody - `dataDetailsResponse` object - `name` string, required - `_type` 'data', required - `metadata` object, required - … - `message` string, required - `status` string, required - `vectorDBDetailsResponse` object - `_type` 'vector_db', required - `metadata` object, required - … - `actualSimilarity` number, double - `similarityThreshold` number, double - `message` string, required - `status` string, required - `toolDetailsResponse` object - `toolName` string, required - `_type` 'tool', required - `metadata` object, required - … - `tips` string[], required - `message` string, required - `status` string, required - `error` object - `heliconeMessage` unknown, required - `model` string, nullable - `instructions` string, nullable - `responses` Response[], nullable - `contentArray` Response[] - `detail` string - `filename` string - `file_id` string - `file_data` string - `idx` number, double - `audio_data` string - `image_url` string - `timestamp` string - `tool_call_id` string - `tool_calls` FunctionCall[] - … - `text` string - `type` 'input_image' | 'input_text' | 'input_file', required - `name` string - `role` 'user' | 'assistant' | 'system' | 'developer', required - `id` string - `_type` 'functionCall' | 'function' | 'image' | 'text' | 'file' | 'contentArray', required - `messages` Message[], nullable - `ending_event_id` string - `trigger_event_id` string - `start_timestamp` string - `annotations` object[] - … - `reasoning` string - `deleted` boolean - `contentArray` Message[] - `idx` number, double - `detail` string - `filename` string - `file_id` string - `file_data` string - `type` 'input_image' | 'input_text' | 'input_file' - `audio_data` string - `image_url` string - `timestamp` string - `tool_call_id` string - `tool_calls` FunctionCall[] - … - `mime_type` string - `content` string - `name` string - `instruction` string - `role` union - … - `id` string - `_type` 'functionCall' | 'function' | 'image' | 'file' | 'message' | 'autoInput' | 'contentArray' | 'audio', required - `country_code` string, nullable, required - `asset_ids` string[], nullable, required - `asset_urls` RecordStringString, required — Construct a type with a set of properties K of type T - `scores` RecordStringNumber, required — Construct a type with a set of properties K of type T - `costUSD` number, double, nullable - `properties` RecordStringString, required — Construct a type with a set of properties K of type T - `assets` string[], required - `target_url` string, required - `model` string, required - `cache_reference_id` string, nullable, required - `cache_enabled` boolean, required - `updated_at` string - `request_referrer` string, nullable - `ai_gateway_body_mapping` string, nullable, required - `storage_location` string - `error` null, nullable, required - ResultErrorString - `data` null, nullable, required - `error` string, required --- [API](https://skmtc.net/helicone/apis/helicone-api.md) · [All operations](https://skmtc.net/helicone/apis/helicone-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helicone/helicone-api/revisions/b369e9e3e80c/schema)