Experiment
Query Experiments
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
Experiment
Query Experiments
Search and filter through experiment data
POST
/
v1
/
experiment
/
query
curl --request POST \
--url https://api.helicone.ai/v1/experiment/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"include": {
"inputs": true,
"promptVersion": true,
"responseBodies": true,
"score": true
},
"filter": {
"experiment": {
"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>"
}
}
}
}'
{
"data": [
{
"id": "<string>",
"organization": "<string>",
"dataset": {
"rows": [
{
"rowId": "<string>",
"inputRecord": {
"request": {
"id": "<string>",
"provider": "<string>"
},
"response": {
"body": "<any>",
"createdAt": "<string>",
"completionTokens": 123,
"promptTokens": 123,
"promptCacheWriteTokens": 123,
"promptCacheReadTokens": 123,
"delayMs": 123,
"model": "<string>"
},
"autoInputs": [
{}
],
"inputs": {},
"requestPath": "<string>",
"requestId": "<string>",
"id": "<string>"
},
"rowIndex": 123,
"columnId": "<string>",
"scores": {}
}
],
"name": "<string>",
"id": "<string>"
},
"meta": "<any>",
"createdAt": "<string>",
"hypotheses": [
{
"runs": [
{
"request": {
"id": "<string>",
"provider": "<string>"
},
"scores": {},
"response": {
"body": "<any>",
"createdAt": "<string>",
"completionTokens": 123,
"promptTokens": 123,
"promptCacheWriteTokens": 123,
"promptCacheReadTokens": 123,
"delayMs": 123,
"model": "<string>"
},
"resultRequestId": "<string>",
"datasetRowId": "<string>"
}
],
"providerKey": "<string>",
"createdAt": "<string>",
"status": "<string>",
"model": "<string>",
"parentPromptVersion": {
"template": "<any>"
},
"promptVersion": {
"template": "<any>"
},
"promptVersionId": "<string>",
"id": "<string>"
}
],
"scores": {
"dataset": {
"scores": {}
},
"hypothesis": {
"scores": {},
"runsCount": 123
}
},
"tableId": "<string>"
}
]
}
Authorizations
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
Response
200 - application/json
Ok
Construct a type with a set of properties K of type T
Construct a type with a set of properties K of type T
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/experiment/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"include": {
"inputs": true,
"promptVersion": true,
"responseBodies": true,
"score": true
},
"filter": {
"experiment": {
"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>"
}
}
}
}'
{
"data": [
{
"id": "<string>",
"organization": "<string>",
"dataset": {
"rows": [
{
"rowId": "<string>",
"inputRecord": {
"request": {
"id": "<string>",
"provider": "<string>"
},
"response": {
"body": "<any>",
"createdAt": "<string>",
"completionTokens": 123,
"promptTokens": 123,
"promptCacheWriteTokens": 123,
"promptCacheReadTokens": 123,
"delayMs": 123,
"model": "<string>"
},
"autoInputs": [
{}
],
"inputs": {},
"requestPath": "<string>",
"requestId": "<string>",
"id": "<string>"
},
"rowIndex": 123,
"columnId": "<string>",
"scores": {}
}
],
"name": "<string>",
"id": "<string>"
},
"meta": "<any>",
"createdAt": "<string>",
"hypotheses": [
{
"runs": [
{
"request": {
"id": "<string>",
"provider": "<string>"
},
"scores": {},
"response": {
"body": "<any>",
"createdAt": "<string>",
"completionTokens": 123,
"promptTokens": 123,
"promptCacheWriteTokens": 123,
"promptCacheReadTokens": 123,
"delayMs": 123,
"model": "<string>"
},
"resultRequestId": "<string>",
"datasetRowId": "<string>"
}
],
"providerKey": "<string>",
"createdAt": "<string>",
"status": "<string>",
"model": "<string>",
"parentPromptVersion": {
"template": "<any>"
},
"promptVersion": {
"template": "<any>"
},
"promptVersionId": "<string>",
"id": "<string>"
}
],
"scores": {
"dataset": {
"scores": {}
},
"hypothesis": {
"scores": {},
"runsCount": 123
}
},
"tableId": "<string>"
}
]
}