How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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
Has prompts
HasPrompts → 200
POST
/v1/prompt/query
Get prompts
GetPrompts body → 200
POST
/v1/prompt/{promptId}/query
Get prompt
GetPrompt 1 param body → 200
DELETE
/v1/prompt/{promptId}
Delete prompt
DeletePrompt 1 param → 204
POST
/v1/prompt/create
Create prompt
CreatePrompt body → 200
PATCH
/v1/prompt/{promptId}/user-defined-id
Update prompt user defined id
UpdatePromptUserDefinedId 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/edit-label
Edit prompt version label
EditPromptVersionLabel 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/edit-template
Edit prompt version template
EditPromptVersionTemplate 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/subversion-from-ui
Create subversion from ui
CreateSubversionFromUi 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/subversion
Create subversion
CreateSubversion 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/promote
Promote prompt version to production
PromotePromptVersionToProduction 1 param body → 200
POST
/v1/prompt/version/{promptVersionId}/inputs/query
Get inputs
GetInputs 1 param body → 200
GET
/v1/prompt/{promptId}/experiments
Get prompt experiments
GetPromptExperiments 1 param → 200
POST
/v1/prompt/{promptId}/versions/query
Get prompt versions
GetPromptVersions 1 param body → 200
GET
/v1/prompt/version/{promptVersionId}
Get prompt version
GetPromptVersion 1 param → 200
DELETE
/v1/prompt/version/{promptVersionId}
Delete prompt version
DeletePromptVersion 1 param → 200
POST
/v1/prompt/{user_defined_id}/compile
Get prompt versions compiled
GetPromptVersionsCompiled 1 param body → 200
POST
/v1/prompt/{user_defined_id}/template
Get prompt version templates
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 PromptVersionResult (11 properties), PromptResult (11 properties), PromptInputRecord (9 properties), PromptsResult (7 properties). Each schema is shown below with its type and property counts.

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

This is an independent, third-party profile of Helicone Prompt API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.