Skip to content

Commit 7e146fa

Browse files
replicas-connector[bot]claudeH2Shami
authored
feat(prompts): add includePromptBody parameter to get prompt version endpoints (#5554)
* feat(prompts): add v2 endpoints to get prompt messages from prompt version Adds new v2 API endpoints under /v2/prompt-2025 that include the full prompt body (messages, tools, etc.) in the response. This addresses customer feedback requesting the ability to get all prompt messages from a prompt version via the API endpoint. New v2 endpoints (include prompt_body in response): - POST /v2/prompt-2025/query/version - POST /v2/prompt-2025/query/production-version - POST /v2/prompt-2025/query/environment-version Existing v1 endpoints remain unchanged for backwards compatibility: - POST /v1/prompt-2025/query/version - POST /v1/prompt-2025/query/production-version - POST /v1/prompt-2025/query/environment-version Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(prompts): add v2 endpoints to get prompt messages from prompt version Adds a new GET endpoint to retrieve the full prompt body (messages, tools, etc.) for a specific prompt version. This addresses customer feedback requesting the ability to get all prompt messages from a prompt version via the API endpoint. New endpoint: - GET /v1/prompt-2025/{promptVersionId}/prompt-body Existing endpoints remain unchanged for backwards compatibility. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * add docs + autogenerated files --------- Co-authored-by: replicas-connector[bot] <replicas-connector[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Hammad Shami <hammad@helicone.ai>
1 parent fa247bc commit 7e146fa

File tree

16 files changed

+2375
-32
lines changed

16 files changed

+2375
-32
lines changed

‎bifrost/lib/clients/jawnTypes/private.ts‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,19 @@ export interface paths {
273273
"/v1/prompt-2025/query/total-versions": {
274274
post: operations["GetPrompt2025TotalVersions"];
275275
};
276+
"/v1/prompt-2025/{promptVersionId}/prompt-body": {
277+
/** @description Get the full prompt body (messages, tools, etc.) for a specific prompt version. */
278+
get: operations["GetPrompt2025VersionBody"];
279+
};
280+
"/v2/prompt-2025/query/version": {
281+
post: operations["GetPrompt2025Version"];
282+
};
283+
"/v2/prompt-2025/query/environment-version": {
284+
post: operations["GetPrompt2025EnvironmentVersion"];
285+
};
286+
"/v2/prompt-2025/query/production-version": {
287+
post: operations["GetPrompt2025ProductionVersion"];
288+
};
276289
"/v1/request/count/query": {
277290
post: operations["GetRequestCount"];
278291
};
@@ -1678,6 +1691,58 @@ Json: JsonObject;
16781691
error: null;
16791692
};
16801693
"Result_Prompt2025-Array.string_": components["schemas"]["ResultSuccess_Prompt2025-Array_"] | components["schemas"]["ResultError_string_"];
1694+
/** @description Construct a type with a set of properties K of type T */
1695+
"Record_string.unknown_": {
1696+
[key: string]: unknown;
1697+
};
1698+
Prompt2025VersionPromptBody: {
1699+
model?: string;
1700+
messages?: ({
1701+
tool_calls?: {
1702+
/** @enum {string} */
1703+
type: "function";
1704+
function: {
1705+
arguments: string;
1706+
name: string;
1707+
};
1708+
id: string;
1709+
}[];
1710+
tool_call_id?: string;
1711+
name?: string;
1712+
content: (string | {
1713+
image_url?: {
1714+
url: string;
1715+
};
1716+
text?: string;
1717+
type: string;
1718+
}[]) | null;
1719+
role: string;
1720+
})[];
1721+
/** Format: double */
1722+
temperature?: number;
1723+
/** Format: double */
1724+
top_p?: number;
1725+
/** Format: double */
1726+
max_tokens?: number;
1727+
tools?: {
1728+
function: {
1729+
parameters: components["schemas"]["Record_string.unknown_"];
1730+
description: string;
1731+
name: string;
1732+
};
1733+
/** @enum {string} */
1734+
type: "function";
1735+
}[];
1736+
tool_choice?: string | {
1737+
function?: {
1738+
name: string;
1739+
/** @enum {string} */
1740+
type: "function";
1741+
};
1742+
type: string;
1743+
};
1744+
[key: string]: unknown;
1745+
};
16811746
Prompt2025Version: {
16821747
id: string;
16831748
model: string;
@@ -1690,6 +1755,11 @@ Json: JsonObject;
16901755
environments?: string[];
16911756
created_at: string;
16921757
s3_url?: string;
1758+
/**
1759+
* @description The full prompt body including messages. Only included when explicitly requested
1760+
* via the `includePromptBody` parameter to avoid unnecessary data transfer.
1761+
*/
1762+
prompt_body?: components["schemas"]["Prompt2025VersionPromptBody"];
16931763
};
16941764
ResultSuccess_Prompt2025Version_: {
16951765
data: components["schemas"]["Prompt2025Version"];
@@ -1715,6 +1785,12 @@ Json: JsonObject;
17151785
error: null;
17161786
};
17171787
"Result_PromptVersionCounts.string_": components["schemas"]["ResultSuccess_PromptVersionCounts_"] | components["schemas"]["ResultError_string_"];
1788+
ResultSuccess_Prompt2025Version_91_prompt_body_93__: {
1789+
data: components["schemas"]["Prompt2025VersionPromptBody"];
1790+
/** @enum {number|null} */
1791+
error: null;
1792+
};
1793+
"Result_Prompt2025Version_91_prompt_body_93_.string_": components["schemas"]["ResultSuccess_Prompt2025Version_91_prompt_body_93__"] | components["schemas"]["ResultError_string_"];
17181794
/** @description Make all properties in T optional */
17191795
Partial_TextOperators_: {
17201796
"not-equals"?: string;
@@ -18464,6 +18540,22 @@ export interface operations {
1846418540
};
1846518541
};
1846618542
};
18543+
/** @description Get the full prompt body (messages, tools, etc.) for a specific prompt version. */
18544+
GetPrompt2025VersionBody: {
18545+
parameters: {
18546+
path: {
18547+
promptVersionId: string;
18548+
};
18549+
};
18550+
responses: {
18551+
/** @description Ok */
18552+
200: {
18553+
content: {
18554+
"application/json": components["schemas"]["Result_Prompt2025Version_91_prompt_body_93_.string_"];
18555+
};
18556+
};
18557+
};
18558+
};
1846718559
GetRequestCount: {
1846818560
requestBody: {
1846918561
content: {

‎bifrost/lib/clients/jawnTypes/public.ts‎

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,19 @@ export interface paths {
121121
"/v1/prompt-2025/query/total-versions": {
122122
post: operations["GetPrompt2025TotalVersions"];
123123
};
124+
"/v1/prompt-2025/{promptVersionId}/prompt-body": {
125+
/** @description Get the full prompt body (messages, tools, etc.) for a specific prompt version. */
126+
get: operations["GetPrompt2025VersionBody"];
127+
};
128+
"/v2/prompt-2025/query/version": {
129+
post: operations["GetPrompt2025Version"];
130+
};
131+
"/v2/prompt-2025/query/environment-version": {
132+
post: operations["GetPrompt2025EnvironmentVersion"];
133+
};
134+
"/v2/prompt-2025/query/production-version": {
135+
post: operations["GetPrompt2025ProductionVersion"];
136+
};
124137
"/v1/prompt/has-prompts": {
125138
get: operations["HasPrompts"];
126139
};
@@ -1246,6 +1259,58 @@ export interface components {
12461259
error: null;
12471260
};
12481261
"Result_Prompt2025-Array.string_": components["schemas"]["ResultSuccess_Prompt2025-Array_"] | components["schemas"]["ResultError_string_"];
1262+
/** @description Construct a type with a set of properties K of type T */
1263+
"Record_string.unknown_": {
1264+
[key: string]: unknown;
1265+
};
1266+
Prompt2025VersionPromptBody: {
1267+
model?: string;
1268+
messages?: ({
1269+
tool_calls?: {
1270+
/** @enum {string} */
1271+
type: "function";
1272+
function: {
1273+
arguments: string;
1274+
name: string;
1275+
};
1276+
id: string;
1277+
}[];
1278+
tool_call_id?: string;
1279+
name?: string;
1280+
content: (string | {
1281+
image_url?: {
1282+
url: string;
1283+
};
1284+
text?: string;
1285+
type: string;
1286+
}[]) | null;
1287+
role: string;
1288+
})[];
1289+
/** Format: double */
1290+
temperature?: number;
1291+
/** Format: double */
1292+
top_p?: number;
1293+
/** Format: double */
1294+
max_tokens?: number;
1295+
tools?: {
1296+
function: {
1297+
parameters: components["schemas"]["Record_string.unknown_"];
1298+
description: string;
1299+
name: string;
1300+
};
1301+
/** @enum {string} */
1302+
type: "function";
1303+
}[];
1304+
tool_choice?: string | {
1305+
function?: {
1306+
name: string;
1307+
/** @enum {string} */
1308+
type: "function";
1309+
};
1310+
type: string;
1311+
};
1312+
[key: string]: unknown;
1313+
};
12491314
Prompt2025Version: {
12501315
id: string;
12511316
model: string;
@@ -1258,6 +1323,11 @@ export interface components {
12581323
environments?: string[];
12591324
created_at: string;
12601325
s3_url?: string;
1326+
/**
1327+
* @description The full prompt body including messages. Only included when explicitly requested
1328+
* via the `includePromptBody` parameter to avoid unnecessary data transfer.
1329+
*/
1330+
prompt_body?: components["schemas"]["Prompt2025VersionPromptBody"];
12611331
};
12621332
ResultSuccess_Prompt2025Version_: {
12631333
data: components["schemas"]["Prompt2025Version"];
@@ -1283,6 +1353,12 @@ export interface components {
12831353
error: null;
12841354
};
12851355
"Result_PromptVersionCounts.string_": components["schemas"]["ResultSuccess_PromptVersionCounts_"] | components["schemas"]["ResultError_string_"];
1356+
ResultSuccess_Prompt2025Version_91_prompt_body_93__: {
1357+
data: components["schemas"]["Prompt2025VersionPromptBody"];
1358+
/** @enum {number|null} */
1359+
error: null;
1360+
};
1361+
"Result_Prompt2025Version_91_prompt_body_93_.string_": components["schemas"]["ResultSuccess_Prompt2025Version_91_prompt_body_93__"] | components["schemas"]["ResultError_string_"];
12861362
"ResultSuccess__hasPrompts-boolean__": {
12871363
data: {
12881364
hasPrompts: boolean;
@@ -2577,10 +2653,6 @@ Json: JsonObject;
25772653
isValid: boolean;
25782654
errors: components["schemas"]["ValidationError"][];
25792655
};
2580-
/** @description Construct a type with a set of properties K of type T */
2581-
"Record_string.unknown_": {
2582-
[key: string]: unknown;
2583-
};
25842656
TypedProviderRequest: {
25852657
url: string;
25862658
json: components["schemas"]["Record_string.unknown_"];
@@ -5569,6 +5641,22 @@ export interface operations {
55695641
};
55705642
};
55715643
};
5644+
/** @description Get the full prompt body (messages, tools, etc.) for a specific prompt version. */
5645+
GetPrompt2025VersionBody: {
5646+
parameters: {
5647+
path: {
5648+
promptVersionId: string;
5649+
};
5650+
};
5651+
responses: {
5652+
/** @description Ok */
5653+
200: {
5654+
content: {
5655+
"application/json": components["schemas"]["Result_Prompt2025Version_91_prompt_body_93_.string_"];
5656+
};
5657+
};
5658+
};
5659+
};
55725660
HasPrompts: {
55735661
responses: {
55745662
/** @description Ok */

‎docs/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@
357357
"rest/prompts/post-v1prompt-2025-query-production-version",
358358
"rest/prompts/post-v1prompt-2025-query-total-versions",
359359
"rest/prompts/get-v1prompt-2025-id-promptid-versionid-inputs",
360+
"rest/prompts/get-v1prompt-2025-promptversionid-prompt-body",
360361
"rest/prompts/get-v1prompt-2025-tags",
361362
"rest/prompts/get-v1prompt-2025-environments",
362363
"rest/prompts/get-v1prompt-2025-count"

‎docs/rest/prompts/get-v1prompt-2025-promptversionid-prompt-body.mdx‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "Get Prompt Body"
3+
api: "GET https://api.helicone.ai/v1/prompt-2025/{promptVersionId}/prompt-body"
4+
description: "Retrieve the full prompt body (messages, tools, etc.) for a specific prompt version"
5+
---
6+
7+
Retrieves the complete prompt body content for a specific prompt version, including messages, model configuration, tools, and other parameters. The prompt body is stored in S3 and contains the actual template content.
8+
9+
### Path Parameters
10+
11+
<ParamField path="promptVersionId" type="string" required>
12+
The unique identifier (UUID) of the prompt version to retrieve
13+
</ParamField>
14+
15+
### Response
16+
17+
<ResponseField name="model" type="string">
18+
The model specified in the prompt (e.g., "gpt-4o-mini", "claude-3-opus")
19+
</ResponseField>
20+
21+
<ResponseField name="messages" type="array">
22+
Array of message objects that make up the prompt template
23+
<Expandable title="Message Object">
24+
<ResponseField name="role" type="string">
25+
The role of the message (e.g., "system", "user", "assistant")
26+
</ResponseField>
27+
<ResponseField name="content" type="string">
28+
The content of the message, may include template variables like `{{ hc:variableName:type }}`
29+
</ResponseField>
30+
</Expandable>
31+
</ResponseField>
32+
33+
<ResponseField name="temperature" type="number" optional>
34+
The temperature setting for the model (if configured)
35+
</ResponseField>
36+
37+
<ResponseField name="max_tokens" type="number" optional>
38+
The maximum number of tokens to generate (if configured)
39+
</ResponseField>
40+
41+
<ResponseField name="tools" type="array" optional>
42+
Array of tool/function definitions (if configured)
43+
</ResponseField>
44+
45+
<RequestExample>
46+
47+
```bash cURL
48+
curl -X GET "https://api.helicone.ai/v1/prompt-2025/6739b412-5fbb-498e-ab99-68ef21eb7df8/prompt-body" \
49+
-H "Authorization: Bearer $HELICONE_API_KEY"
50+
```
51+
52+
```typescript TypeScript
53+
const response = await fetch('https://api.helicone.ai/v1/prompt-2025/6739b412-5fbb-498e-ab99-68ef21eb7df8/prompt-body', {
54+
method: 'GET',
55+
headers: {
56+
'Authorization': `Bearer ${HELICONE_API_KEY}`,
57+
},
58+
});
59+
60+
const promptBody = await response.json();
61+
```
62+
63+
```python Python
64+
import requests
65+
66+
response = requests.get(
67+
'https://api.helicone.ai/v1/prompt-2025/6739b412-5fbb-498e-ab99-68ef21eb7df8/prompt-body',
68+
headers={
69+
'Authorization': f'Bearer {HELICONE_API_KEY}',
70+
}
71+
)
72+
73+
prompt_body = response.json()
74+
```
75+
76+
</RequestExample>
77+
78+
<ResponseExample>
79+
80+
```json Response
81+
{
82+
"data": {
83+
"model": "gpt-4o-mini",
84+
"messages": [
85+
{
86+
"role": "system",
87+
"content": "You are a helpful AI assistant.\n\nYou are speaking to {{ hc:name:string }}"
88+
}
89+
],
90+
"temperature": 0.7,
91+
"max_tokens": 1000
92+
},
93+
"error": null
94+
}
95+
```
96+
97+
</ResponseExample>
98+
99+
### Notes
100+
101+
- This endpoint returns the full prompt body content, unlike other endpoints that only return metadata
102+
- The `promptVersionId` must be a UUID, not the 6-character prompt ID
103+
- Template variables in the format `{{ hc:variableName:type }}` can be used for dynamic content
104+
- Use the `/v1/prompt-2025/query/versions` endpoint to get the version UUID from a prompt ID

0 commit comments

Comments
 (0)