Helicone Experiment API
The Experiment API from Helicone — 40 operation(s) for experiment.
Helicone Experiment API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Experiment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and an engineering blog.
This API exposes 44 operations across 40 paths, and defines 72 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.helicone.ai/, http://localhost:8585/.
44 operations
40 paths
72 schemas
6 DELETE9 GET1 PATCH28 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Helicone Experiment API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
api_key— Bearer token authentication. Format: 'Bearer YOURAPIKEY'
Paths & Operations 44
Across 40 paths, the API surfaces 44 operations — 6 DELETE, 9 GET, 1 PATCH, 28 POST. Each is listed below with its method, path, parameters, and response codes.
Experiment 44
POST
/v2/experiment/create/empty
POST
/v2/experiment/create/from-request/{requestId}
POST
/v2/experiment/new
GET
/v2/experiment
DELETE
/v2/experiment/{experimentId}
GET
/v2/experiment/{experimentId}
POST
/v2/experiment/{experimentId}/prompt-version
DELETE
/v2/experiment/{experimentId}/prompt-version/{promptVersionId}
GET
/v2/experiment/{experimentId}/prompt-versions
GET
/v2/experiment/{experimentId}/input-keys
POST
/v2/experiment/{experimentId}/add-manual-row
POST
/v2/experiment/{experimentId}/add-manual-rows-batch
DELETE
/v2/experiment/{experimentId}/rows
POST
/v2/experiment/{experimentId}/row/insert/batch
POST
/v2/experiment/{experimentId}/row/insert/dataset/{datasetId}
POST
/v2/experiment/{experimentId}/row/update
POST
/v2/experiment/{experimentId}/run-hypothesis
GET
/v2/experiment/{experimentId}/evaluators
POST
/v2/experiment/{experimentId}/evaluators
DELETE
/v2/experiment/{experimentId}/evaluators/{evaluatorId}
POST
/v2/experiment/{experimentId}/evaluators/run
GET
/v2/experiment/{experimentId}/should-run-evaluators
GET
/v2/experiment/{experimentId}/{promptVersionId}/scores
GET
/v2/experiment/{experimentId}/{requestId}/{scoreKey}
POST
/v1/experiment/new-empty
POST
/v1/experiment/table/new
POST
/v1/experiment/table/{experimentTableId}/query
POST
/v1/experiment/table/{experimentTableId}/metadata/query
POST
/v1/experiment/tables/query
POST
/v1/experiment/table/{experimentTableId}/cell
PATCH
/v1/experiment/table/{experimentTableId}/cell
POST
/v1/experiment/table/{experimentTableId}/column
POST
/v1/experiment/table/{experimentTableId}/row/new
DELETE
/v1/experiment/table/{experimentTableId}/row/{rowIndex}
POST
/v1/experiment/table/{experimentTableId}/row/insert/batch
POST
/v1/experiment/update-meta
POST
/v1/experiment
POST
/v1/experiment/hypothesis
POST
/v1/experiment/hypothesis/{hypothesisId}/scores/query
GET
/v1/experiment/{experimentId}/evaluators
POST
/v1/experiment/{experimentId}/evaluators
POST
/v1/experiment/{experimentId}/evaluators/run
DELETE
/v1/experiment/{experimentId}/evaluators/{evaluatorId}
POST
/v1/experiment/query
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are PromptVersionResult (11 properties), ExperimentV2PromptVersion (11 properties), EvaluatorResult (9 properties), Experiment (8 properties). Each schema is shown below with its type and property counts.
ResultSuccess_ExperimentTable_
object
2 properties
2 required
Result__tableId-string--experimentId-string_.string_
ResultSuccess_unknown_
object
2 properties
2 required
ExperimentFilterNode
ExperimentV2PromptVersion
object
11 properties
11 required
Result_Record_string.ScoreV2_.string_
Result_string-Array.string_
NewExperimentParams
object
5 properties
4 required
Result_ScoreV2-or-null.string_
ResultSuccess_boolean_
object
2 properties
2 required
Record_string.ScoreV2_
object
Construct a type with a set of properties K of type T
ExperimentV2
object
6 properties
6 required
Result_ExperimentTable.string_
ResultSuccess_ExtendedExperimentData_
object
2 properties
2 required
Pick_FilterLeaf.experiment_
object
From T, pick a set of properties whose keys are in the union K
1 property
Experiment
object
8 properties
8 required
ResultSuccess_ScoreV2-or-null_
object
2 properties
2 required
Partial_TextOperators_
object
Make all properties in T optional
6 properties
ExperimentV2Row
object
5 properties
5 required
ResultSuccess__runsCount-number--scores-Record_string.Score___
object
2 properties
2 required
ResultSuccess__tableId-string--experimentId-string__
object
2 properties
2 required
IncludeExperimentKeys
object
4 properties
ExtendedExperimentData
object
7 properties
7 required
CreateNewPromptVersionForExperimentParams
object
6 properties
2 required
Result_ExperimentV2-Array.string_
Record_string.any_
object
Construct a type with a set of properties K of type T
ResultSuccess__experimentId-string__
object
2 properties
2 required
ExperimentTableSimplified
object
6 properties
5 required
ResultSuccess_Experiment-Array_
object
2 properties
2 required
Result_boolean.string_
Json
Result_string.string_
Result_null.string_
Result_Experiment-Array.string_
ResultSuccess_ExperimentV2-Array_
object
2 properties
2 required
Partial_ExperimentToOperators_
object
Make all properties in T optional
2 properties
ResultSuccess_ExperimentTableSimplified_
object
2 properties
2 required
ResultSuccess_PromptVersionResult_
object
2 properties
2 required
Result__hypothesisId-string_.string_
ExperimentScores
object
2 properties
2 required
ExperimentV2Output
object
6 properties
6 required
Result_PromptVersionResult.string_
ScoreV2
object
4 properties
4 required
ExperimentFilterBranch
object
3 properties
3 required
Record_string.Score_
object
Construct a type with a set of properties K of type T
ResultSuccess_ExperimentV2PromptVersion-Array_
object
2 properties
2 required
Result_ExperimentV2PromptVersion-Array.string_
ResultSuccess_null_
object
2 properties
2 required
CreateExperimentTableParams
object
7 properties
6 required
ExperimentDatasetRow
object
5 properties
5 required
Result__runsCount-number--scores-Record_string.Score__.string_
ExperimentTable
object
5 properties
4 required
Record_string.string_
object
Construct a type with a set of properties K of type T
Result_ExtendedExperimentData.string_
PromptVersionResult
object
11 properties
8 required
ResultSuccess_string-Array_
object
2 properties
2 required
FilterLeafSubset_experiment_
ResultSuccess_Record_string.ScoreV2__
object
2 properties
2 required
ResultSuccess_string_
object
2 properties
2 required
RequestObj
object
2 properties
2 required
Result_ExperimentTableSimplified-Array.string_
Result_EvaluatorResult-Array.string_
EvaluatorResult
object
9 properties
9 required
ResponseObj
object
8 properties
8 required
Result__experimentId-string_.string_
ResultSuccess_ExperimentTableSimplified-Array_
object
2 properties
2 required
Score
object
2 properties
2 required
Result_ExperimentTableSimplified.string_
ResultSuccess__hypothesisId-string__
object
2 properties
2 required
ExperimentTableColumn
object
6 properties
4 required
ResultError_string_
object
2 properties
2 required
ResultSuccess_EvaluatorResult-Array_
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Helicone 12
Other APIs Helicone publishes across the network.
Helicone Agent API
Helicone API Key API
Helicone Comparison API
Helicone Credits API
Helicone Customer API
Helicone Dashboard API
Helicone Dataset API
Helicone Evals API
Helicone Evaluator API
Helicone HeliconeSql API
Helicone Integration API
Helicone Metrics API
#Experiment