Prompt
Compile Prompt
Request
Prompt
- POSTQuery Prompts
- POSTQuery Prompt
- DELDelete Prompt
- POSTCreate Prompt
- POSTEdit Prompt Version Label
- POSTEdit Prompt Version Template
- POSTGet Prompt Version Subversion
- POSTPromote Prompt Version
- POSTQuery Prompt Version Inputs
- GETGet Prompt Experiments
- POSTQuery Prompt Versions
- GETGet Prompt Version
- DELDelete Prompt Version
- POSTCompile Prompt
- POSTQuery Prompt Template
Evals
Evaluator
Experiment
- POSTCreate Empty Experiment (v2)
- POSTCreate from Request (v2)
- POSTCreate New Experiment (v2)
- GETList Experiments
- GETGet Experiment Details
- POSTAdd Prompt Version
- GETGet Experiment Prompt Versions
- GETGet Experiment Input Keys
- POSTAdd Manual Row (v2)
- POSTBatch Insert Rows (v2)
- POSTPost v2experiment rowupdate
- POSTPost v2experiment run hypothesis
- GETGet Experiment Evaluators (v2)
- POSTAdd Evaluators (v2)
- DELDelete Experiment Evaluator (v2)
- POSTRun Evaluators (v2)
- GETCheck Evaluator Run Status
- GETGet Experiment Scores
- GETGet Experiment Score
- POSTCreate Empty Experiment
- POSTCreate New Table
- POSTQuery Experiment Table
- POSTQuery Table Metadata
- POSTQuery Tables
- POSTCreate Table Cell
- PATCHUpdate Experiment Table Cell
- POSTCreate Table Column
- POSTCreate New Table Row
- DELDelete Experiment Table Row
- POSTBatch Insert Table Rows
- POSTUpdate Metadata
- POSTCreate Experiment
- POSTCreate Experiment Hypothesis
- POSTQuery Hypothesis Scores
- GETGet Experiment Evaluators
- POSTAdd Experiment Evaluators
- POSTRun Experiment Evaluators
- DELDelete Experiment Evaluator
- POSTQuery Experiments
Property
Dataset
Dashboard
Settings
Prompt
Compile Prompt
Compile a prompt with given parameters
POST
/
v1
/
prompt
/
{user_defined_id}
/
compile
curl --request POST \
--url https://api.helicone.ai/v1/prompt/{user_defined_id}/compile \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"filter": {
"prompts_versions": {
"minor_version": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"major_version": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_v2": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
}
},
"includeExperimentVersions": true,
"inputs": {}
}'{
"data": {
"id": "<string>",
"minor_version": 123,
"major_version": 123,
"prompt_v2": "<string>",
"model": "<string>",
"prompt_compiled": "<any>"
}
}Authorizations
Path Parameters
Body
application/json
From T, pick a set of properties whose keys are in the union K
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/prompt/{user_defined_id}/compile \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"filter": {
"prompts_versions": {
"minor_version": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"major_version": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_v2": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
}
},
"includeExperimentVersions": true,
"inputs": {}
}'{
"data": {
"id": "<string>",
"minor_version": 123,
"major_version": 123,
"prompt_v2": "<string>",
"model": "<string>",
"prompt_compiled": "<any>"
}
}