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)
- POSTUpdate Rows (v2)
- POSTRun Hypothesis (v2)
- 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
Request
Get Requests (Point Queries)
Retrieve all requests visible in the request table at Helicone.
POST
/
v1
/
request
/
query
curl --request POST \
--url https://api.helicone.ai/v1/request/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"filter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"response_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"organization_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"node_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"job_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"threat": {
"equals": true
},
"request_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"target_url": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"properties": {},
"search_properties": {},
"scores": {},
"scores_column": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_body": {
"contains": "<string>"
},
"response_body": {
"contains": "<string>"
},
"cache_enabled": {
"equals": true
}
},
"response": {
"body_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"body_model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"body_completion": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"request": {
"prompt": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"auth_hash": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"org_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"node_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"modelOverride": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"path": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"feedback": {
"id": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"rating": {
"equals": true
},
"response_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"sessions_request_response_rmt": {
"session_session_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"session_session_name": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"session_total_cost": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_total_requests": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"session_latest_request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"session_tag": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"cache_hits": {
"organization_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
}
},
"properties": {},
"values": {}
},
"offset": 123,
"limit": 123,
"sort": {
"random": true,
"created_at": "asc",
"cache_created_at": "asc",
"latency": "asc",
"last_active": "asc",
"total_tokens": "asc",
"completion_tokens": "asc",
"prompt_tokens": "asc",
"user_id": "asc",
"body_model": "asc",
"is_cached": "asc",
"request_prompt": "asc",
"response_text": "asc",
"properties": {},
"values": {},
"cost_usd": "asc"
},
"isCached": true,
"includeInputs": true,
"isPartOfExperiment": true,
"isScored": true
}'
{
"filter": "all",
"isCached": false,
"limit": 10,
"offset": 0,
"sort": {
"created_at": "desc"
},
"isScored": false,
"isPartOfExperiment": false
}
For users in the European Union: Please use eu.api.helicone.ai
instead of
api.helicone.ai
.
This API is optimized for point queries. For bulk queries, use the Get Requests (faster) API.
The following API lets you get all of the requests that would be visible in the request table at helicone.ai/requests.
Premade examples 👇
Filter | Description |
---|---|
Get Request by User | Get all the requests made by a user |
Filter
A filter is either a FilterLeaf or a FilterBranch, and can be composed of multiple filters generating an AST of ANDs/ORs.
Here is how it is represented in typescript:
export interface FilterBranch {
left: FilterNode;
operator: "or" | "and"; // Can add more later
right: FilterNode;
}
export type FilterNode = FilterLeaf | FilterBranch | "all";
This allows us to build complex filters like this:
{
"filter": {
"operator": "and",
"right": {
"request": {
"model": {
"contains": "gpt-4"
}
}
},
"left": {
"request": {
"user_id": {
"equals": "abc@email.com"
}
}
}
}
}
Authorizations
Body
application/json
Response
200 - application/json
Ok
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/request/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"filter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"response_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"organization_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"node_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"job_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"threat": {
"equals": true
},
"request_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"target_url": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"properties": {},
"search_properties": {},
"scores": {},
"scores_column": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_body": {
"contains": "<string>"
},
"response_body": {
"contains": "<string>"
},
"cache_enabled": {
"equals": true
}
},
"response": {
"body_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"body_model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"body_completion": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"request": {
"prompt": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"auth_hash": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"org_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"node_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"modelOverride": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"path": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"feedback": {
"id": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"rating": {
"equals": true
},
"response_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"sessions_request_response_rmt": {
"session_session_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"session_session_name": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"session_total_cost": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_total_requests": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"session_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"session_latest_request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"session_tag": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
}
},
"cache_hits": {
"organization_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
}
},
"properties": {},
"values": {}
},
"offset": 123,
"limit": 123,
"sort": {
"random": true,
"created_at": "asc",
"cache_created_at": "asc",
"latency": "asc",
"last_active": "asc",
"total_tokens": "asc",
"completion_tokens": "asc",
"prompt_tokens": "asc",
"user_id": "asc",
"body_model": "asc",
"is_cached": "asc",
"request_prompt": "asc",
"response_text": "asc",
"properties": {},
"values": {},
"cost_usd": "asc"
},
"isCached": true,
"includeInputs": true,
"isPartOfExperiment": true,
"isScored": true
}'
{
"filter": "all",
"isCached": false,
"limit": 10,
"offset": 0,
"sort": {
"created_at": "desc"
},
"isScored": false,
"isPartOfExperiment": false
}
Assistant
Responses are generated using AI and may contain mistakes.