Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,7 @@
"rest/request/post-v1requestquery-clickhouse",
"rest/request/post-v1requestquery",
"rest/request/get-v1request",
"rest/request/get-v1request-inputs",
"rest/request/post-v1requestquery-ids",
"rest/request/post-v1request-feedback",
"rest/request/put-v1request-property",
Expand Down
53 changes: 53 additions & 0 deletions docs/rest/request/get-v1request-inputs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "Get Request Inputs"
sidebarTitle: "Get Request Inputs"
description: "Retrieve the prompt template inputs (variables) used for a specific request made through AI Gateway prompt management."
"twitter:title": "Get Request Inputs - Helicone OSS LLM Observability"
openapi: get /v1/request/{requestId}/inputs
---

import EUAPIWarning from "/snippets/eu-api-warning.mdx";

<EUAPIWarning />

## Overview

When you use [Prompt Management](/features/advanced-usage/prompts/overview) through the AI Gateway, template variables (inputs) are stored automatically. This endpoint lets you retrieve those inputs by request ID — useful for building testing pipelines that replay past requests against new prompt versions.

## Use Cases

- **Regression testing**: Pull a past request's inputs and replay them against a new prompt version to validate behavior.
- **Prompt comparison**: Compare outputs across prompt versions using the same inputs, without storing inputs separately on your end.
- **Debugging**: Inspect the exact variables that were injected into a prompt template at runtime.

<Note>Request data is retained for 90 days. Plan your testing workflows accordingly.</Note>

## Response

Returns `null` for `data` if the request has no associated inputs (e.g., the request was not made through prompt management, or the request ID doesn't exist).

### Example Response

```json
{
"data": {
"inputs": {
"customer_name": "Sarah",
"issue": "refund request"
},
"prompt_id": "customer-support",
"version_id": "1c7a86c8-...",
"environment": "production"
},
"error": null
}
```

### No Inputs Found

```json
{
"data": null,
"error": null
}
```
Loading