/
HE
helicone
/
helicone-api
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5m ago · Updated 4mo ago
b369e9e3e80c
latest
OpenAPI 3.0.0
MIT
raw.githubusercontent.com
2026-04-04
267
543
485.7 KB
Agent
9
post
/v1/agent/generate
post
/v1/agent/thread/{sessionId}/message
get
/v1/agent/thread/{sessionId}
delete
/v1/agent/thread/{sessionId}
post
/v1/agent/thread/{sessionId}/escalate
post
/v1/agent/thread/create-and-escalate
post
/v1/agent/thread/{sessionId}/reopen
get
/v1/agent/threads
post
/v1/agent/mcp/search
API Key
10
get
/v1/api-keys/provider-key/{providerKeyId}
delete
/v1/api-keys/provider-key/{providerKeyId}
patch
/v1/api-keys/provider-key/{providerKeyId}
post
/v1/api-keys/provider-key
get
/v1/api-keys/provider-keys
get
/v1/api-keys
post
/v1/api-keys
post
/v1/api-keys/proxy-key
delete
/v1/api-keys/{apiKeyId}
patch
/v1/api-keys/{apiKeyId}
Comparison
1
post
/v1/public/compare/models
Credits
6
get
/v1/credits/balance
get
/v1/credits/payments
get
/v1/credits/totalSpend
get
/v1/credits/spend/breakdown
get
/v1/credits/invoices
get
/v1/credits/discounts
Customer
2
post
/v1/customer/{customerId}/usage/query
post
/v1/customer/query
Dashboard
1
post
/v1/dashboard/scores/query
Dataset
14
post
/v1/experiment/dataset
post
/v1/experiment/dataset/random
post
/v1/experiment/dataset/query
post
/v1/experiment/dataset/{datasetId}/row/insert
post
/v1/experiment/dataset/{datasetId}/version/{promptVersionId}/row/new
post
/v1/experiment/dataset/{datasetId}/inputs/query
post
/v1/experiment/dataset/{datasetId}/mutate
post
/v1/helicone-dataset
post
/v1/helicone-dataset/{datasetId}/mutate
post
/v1/helicone-dataset/{datasetId}/query
post
/v1/helicone-dataset/{datasetId}/count
post
/v1/helicone-dataset/query
post
/v1/helicone-dataset/{datasetId}/request/{requestId}
post
/v1/helicone-dataset/{datasetId}/delete
Evals
4
post
/v1/evals/query
get
/v1/evals/scores
post
/v1/evals/{requestId}
post
/v1/evals/score-distributions/query
Evaluator
13
post
/v1/evaluator
get
/v1/evaluator/{evaluatorId}
put
/v1/evaluator/{evaluatorId}
delete
/v1/evaluator/{evaluatorId}
post
/v1/evaluator/query
get
/v1/evaluator/{evaluatorId}/experiments
get
/v1/evaluator/{evaluatorId}/onlineEvaluators
post
/v1/evaluator/{evaluatorId}/onlineEvaluators
delete
/v1/evaluator/{evaluatorId}/onlineEvaluators/{onlineEvaluatorId}
post
/v1/evaluator/python/test
post
/v1/evaluator/llm/test
post
/v1/evaluator/lastmile/test
get
/v1/evaluator/{evaluatorId}/stats
Experiment
44
post
/v2/experiment/create/empty
post
/v2/experiment/create/from-request/{requestId}
post
/v2/experiment/new
get
/v2/experiment
get
/v2/experiment/{experimentId}
delete
/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
HeliconeSql
9
get
Get database schema
post
Execute SQL query
post
Download query results as CSV
get
List saved queries
get
Get saved query
put
Update saved query
delete
Delete saved query
post
Bulk delete saved queries
post
Create saved query
Integration
8
get
/v1/integration
post
/v1/integration
get
/v1/integration/{integrationId}
post
/v1/integration/{integrationId}
get
/v1/integration/type/{type}
get
/v1/integration/slack/settings
get
/v1/integration/slack/channels
post
/v1/integration/{integrationId}/stripe/test-meter-event
Metrics
20
post
/v1/metrics/totalRequests
post
/v1/metrics/totalCost
post
/v1/metrics/averageLatency
post
/v1/metrics/averageTimeToFirstToken
post
/v1/metrics/averageTokensPerRequest
post
/v1/metrics/totalThreats
post
/v1/metrics/activeUsers
post
/v1/metrics/requestOverTime
post
/v1/metrics/costOverTime
post
/v1/metrics/tokensOverTime
post
/v1/metrics/latencyOverTime
post
/v1/metrics/timeToFirstToken
post
/v1/metrics/usersOverTime
post
/v1/metrics/threatsOverTime
post
/v1/metrics/errorOverTime
post
/v1/metrics/requestStatusOverTime
post
/v1/metrics/requestCount
post
/v1/metrics/models
post
/v1/metrics/country
post
/v1/metrics/quantiles
Model Registry
1
get
Returns a comprehensive list of all AI models with their configurations, pricing, and capabilities
Models
2
get
/v1/models
get
/v1/models/multimodal
PI
6
post
/v1/public/pi/get-api-key
post
/v1/pi/session
post
/v1/pi/org-name/query
post
/v1/pi/total-costs
post
/v1/pi/total_requests
post
/v1/pi/costs-over-time/query
Playground
3
post
/v1/playground/generate
get
/v1/playground/requests-through-helicone
post
/v1/playground/requests-through-helicone
Prompt
18
get
/v1/prompt/has-prompts
post
/v1/prompt/query
post
/v1/prompt/{promptId}/query
delete
/v1/prompt/{promptId}
post
/v1/prompt/create
patch
/v1/prompt/{promptId}/user-defined-id
post
/v1/prompt/version/{promptVersionId}/edit-label
post
/v1/prompt/version/{promptVersionId}/edit-template
post
/v1/prompt/version/{promptVersionId}/subversion-from-ui
post
/v1/prompt/version/{promptVersionId}/subversion
post
/v1/prompt/version/{promptVersionId}/promote
post
/v1/prompt/version/{promptVersionId}/inputs/query
get
/v1/prompt/{promptId}/experiments
post
/v1/prompt/{promptId}/versions/query
get
/v1/prompt/version/{promptVersionId}
delete
/v1/prompt/version/{promptVersionId}
post
/v1/prompt/{user_defined_id}/compile
post
/v1/prompt/{user_defined_id}/template
Prompt2025
20
get
/v1/prompt-2025/id/{promptId}
post
/v1/prompt-2025/id/{promptId}/rename
patch
/v1/prompt-2025/id/{promptId}/tags
delete
/v1/prompt-2025/{promptId}
delete
/v1/prompt-2025/{promptId}/{versionId}
get
/v1/prompt-2025/id/{promptId}/{versionId}/inputs
get
/v1/prompt-2025/tags
get
/v1/prompt-2025/environments
post
/v1/prompt-2025
post
/v1/prompt-2025/update
post
/v1/prompt-2025/update/environment
post
/v1/prompt-2025/remove/environment
get
/v1/prompt-2025/count
post
/v1/prompt-2025/query
post
/v1/prompt-2025/query/version
post
/v1/prompt-2025/query/environment-version
post
/v1/prompt-2025/query/versions
post
/v1/prompt-2025/query/production-version
post
/v1/prompt-2025/query/total-versions
get
/v1/prompt-2025/{promptVersionId}/prompt-body
Prompt2025V2
3
post
/v2/prompt-2025/query/version
post
/v2/prompt-2025/query/environment-version
post
/v2/prompt-2025/query/production-version
Property
8
post
/v1/property/properties/over-time
post
/v1/property/query
post
/v1/property/hide
post
/v1/property/hidden/query
post
/v1/property/restore
post
/v1/property/{propertyKey}/search
post
/v1/property/{propertyKey}/top-costs/query
post
/v1/property/{propertyKey}/top-requests/query
Providers
1
post
/v1/providers
Request
10
post
/v1/request/count/query
post
/v1/request/query
post
/v1/request/query-clickhouse
get
/v1/request/{requestId}
get
/v1/request/{requestId}/inputs
post
/v1/request/query-ids
post
/v1/request/{requestId}/feedback
put
/v1/request/{requestId}/property
post
/v1/request/{requestId}/assets/{assetId}
post
/v1/request/{requestId}/score
Security
1
post
/v1/public/security
Session
7
post
/v1/session/query
post
/v1/session/count
post
/v1/session/name/query
post
/v1/session/metrics/query
post
/v1/session/{sessionId}/feedback
get
/v1/session/{sessionId}/tag
post
/v1/session/{sessionId}/tag
Status
2
get
/v1/public/status/provider
get
/v1/public/status/provider/{provider}
Stripe
25
get
/v1/stripe/subscription/cost-for-prompts
get
/v1/stripe/subscription/cost-for-evals
get
/v1/stripe/subscription/cost-for-experiments
get
/v1/stripe/subscription/free/usage
post
/v1/stripe/cloud/checkout-session
post
/v1/stripe/subscription/new-customer/upgrade-to-pro
post
/v1/stripe/subscription/existing-customer/upgrade-to-pro
post
/v1/stripe/subscription/new-customer/upgrade-to-team-bundle
post
/v1/stripe/subscription/existing-customer/upgrade-to-team-bundle
post
/v1/stripe/subscription/manage-subscription
post
/v1/stripe/subscription/undo-cancel-subscription
post
/v1/stripe/subscription/add-ons/{productType}
delete
/v1/stripe/subscription/add-ons/{productType}
get
/v1/stripe/subscription/preview-invoice
post
/v1/stripe/subscription/cancel-subscription
post
/v1/stripe/subscription/migrate-to-pro
get
/v1/stripe/payment-intents/search
get
/v1/stripe/subscription
get
/v1/stripe/auto-topoff/settings
post
/v1/stripe/auto-topoff/settings
delete
/v1/stripe/auto-topoff/settings
get
/v1/stripe/payment-methods
post
/v1/stripe/payment-methods/setup-session
delete
/v1/stripe/payment-methods/{paymentMethodId}
get
/v1/stripe/subscription/usage-stats
Test
1
post
/v1/test/gateway-request
Trace
5
post
/v1/trace/custom/v1/log
post
/v1/trace/custom/log
post
/v1/trace/custom/log/typed
post
/v1/trace/log
post
/v1/trace/log-python
User
3
post
/v1/user/metrics-overview/query
post
/v1/user/metrics/query
post
/v1/user/query
Vault
4
post
/v1/vault/add
get
/v1/vault/keys
get
/v1/vault/key/{providerKeyId}
patch
/v1/vault/update/{id}
Webhooks
4
get
/v1/webhooks
post
/v1/webhooks
delete
/v1/webhooks/{webhookId}
post
/v1/webhooks/{webhookId}/test
Wrapped
2
get
/v1/wrapped/2025
get
/v1/wrapped/2025/check
API Key
get
/v1/api-keys/provider-key/{providerKeyId}
Path parameters
providerKeyId
string
required
Response
Ok
union
required
DecryptedProviderKey
required
OR
object
required