Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Helicone Prompt API

The Prompt API from Helicone — 17 operation(s) for prompt.

Helicone Prompt API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Prompt. 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 18 operations across 17 paths, and defines 53 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/.

18 operations 17 paths 53 schemas 2 DELETE3 GET1 PATCH12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://ai-gateway.helicone.ai
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Helicone Prompt 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 18

Across 17 paths, the API surfaces 18 operations — 2 DELETE, 3 GET, 1 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Prompt 18
GET
/v1/prompt/has-prompts
HasPrompts → 200
POST
/v1/prompt/query
GetPrompts body → 200
POST
/v1/prompt/{promptId}/query
GetPrompt 1 param body → 200
DELETE
/v1/prompt/{promptId}
DeletePrompt 1 param → 204
POST
/v1/prompt/create
CreatePrompt body → 200
PATCH
/v1/prompt/{promptId}/user-defined-id
UpdatePromptUserDefinedId 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/edit-label
EditPromptVersionLabel 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/edit-template
EditPromptVersionTemplate 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/subversion-from-ui
CreateSubversionFromUi 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/subversion
CreateSubversion 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/promote
PromotePromptVersionToProduction 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/inputs/query
GetInputs 1 param body → 200
GET
/v1/prompt/{promptId}/experiments
GetPromptExperiments 1 param → 200
POST
/v1/prompt/{promptId}/versions/query
GetPromptVersions 1 param body → 200
GET
/v1/prompt/version/{promptVersionId}
GetPromptVersion 1 param → 200
DELETE
/v1/prompt/version/{promptVersionId}
DeletePromptVersion 1 param → 200
POST
/v1/prompt/{user_defined_id}/compile
GetPromptVersionsCompiled 1 param body → 200
POST
/v1/prompt/{user_defined_id}/template
GetPromptVersionTemplates 1 param body → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are PromptResult (11 properties), PromptVersionResult (11 properties), PromptInputRecord (9 properties), PromptsResult (7 properties). Each schema is shown below with its type and property counts.

Result_PromptResult.string_
PromptEditSubversionLabelParams
object
1 property 1 required
FilterLeafSubset_prompt_v2_
FilterLeafSubset_prompts_versions_
PromptResult
object
11 properties 10 required
ResultSuccess_CreatePromptResponse_
object
2 properties 2 required
Result_PromptInputRecord-Array.string_
Result__id-string--created_at-string--num_hypotheses-number--dataset-string--meta-Record_string.any__-Array.string_
Pick_FilterLeaf.prompt_v2_
object
From T, pick a set of properties whose keys are in the union K
1 property
Partial_TextOperators_
object
Make all properties in T optional
6 properties
PromptQueryParams
object
1 property 1 required
ResultSuccess_PromptVersionResultFilled_
object
2 properties 2 required
Result__metadata-Record_string.any__.string_
Result_PromptVersionResultCompiled.string_
ResultSuccess__id-string--created_at-string--num_hypotheses-number--dataset-string--meta-Record_string.any__-Array_
object
2 properties 2 required
Record_string.any_
object
Construct a type with a set of properties K of type T
Result_PromptVersionResult-Array.string_
PromptsFilterBranch
object
3 properties 3 required
Result_CreatePromptResponse.string_
PromptVersionsFilterNode
Partial_NumberOperators_
object
Make all properties in T optional
6 properties
PromptVersionsQueryParams
object
2 properties
ResultSuccess_PromptVersionResult-Array_
object
2 properties 2 required
ResultSuccess_PromptInputRecord-Array_
object
2 properties 2 required
PromptVersionsFilterBranch
object
3 properties 3 required
Result_null.string_
Pick_FilterLeaf.prompts_versions_
object
From T, pick a set of properties whose keys are in the union K
1 property
Partial_PromptVersionsToOperators_
object
Make all properties in T optional
4 properties
PromptsResult
object
7 properties 6 required
PromptsQueryParams
object
1 property 1 required
ResultSuccess_PromptVersionResult_
object
2 properties 2 required
PromptCreateSubversionParams
object
5 properties 1 required
Result_PromptVersionResult.string_
ResultSuccess_null_
object
2 properties 2 required
PromptEditSubversionTemplateParams
object
2 properties 1 required
PromptVersionResultFilled
object
6 properties 6 required
Result_PromptsResult-Array.string_
Partial_PromptToOperators_
object
Make all properties in T optional
2 properties
CreatePromptResponse
object
2 properties 2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
Result_PromptVersionResultFilled.string_
PromptVersionResult
object
11 properties 8 required
PromptVersiosQueryParamsCompiled
object
3 properties 1 required
Result__hasPrompts-boolean_.string_
PromptsFilterNode
ResultSuccess__metadata-Record_string.any___
object
2 properties 2 required
PromptInputRecord
object
9 properties 6 required
ResultSuccess_PromptVersionResultCompiled_
object
2 properties 2 required
PromptVersionResultCompiled
object
6 properties 6 required
ResultSuccess__hasPrompts-boolean__
object
2 properties 2 required
ResultSuccess_PromptsResult-Array_
object
2 properties 2 required
ResultSuccess_PromptResult_
object
2 properties 2 required
ResultError_string_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-prompt-api-openapi.yml Raw ↑

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 Experiment API
Helicone HeliconeSql API
Helicone Integration API