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 Playground API

The Playground API from Helicone — 2 operation(s) for playground.

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

Tagged areas include Playground. 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 3 operations across 2 paths, and defines 29 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/.

3 operations 2 paths 29 schemas 1 GET2 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 Playground 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 3

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

Playground 3
POST
/v1/playground/generate
Generate body → 200
POST
/v1/playground/requests-through-helicone
RequestsThroughHelicone body → 200
GET
/v1/playground/requests-through-helicone
GetRequestsThroughHelicone → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are OpenAIChatRequest (31 properties), ChatCompletion (8 properties), ChatCompletionMessage (7 properties), CompletionUsage (5 properties). Each schema is shown below with its type and property counts.

Record_string.string_
object
Construct a type with a set of properties K of type T
CompletionUsage.CompletionTokensDetails
object
Breakdown of tokens used in a completion.
4 properties
ResultSuccess_ChatCompletion-or-_content-string--reasoning-string--calls-any__
object
2 properties 2 required
ChatCompletionMessageCustomToolCall.Custom
object
The custom tool that the model called.
2 properties 2 required
OpenAIChatRequest
object
Simplified interface for the OpenAI Chat request format
31 properties
CompletionUsage.PromptTokensDetails
object
Breakdown of tokens used in the prompt.
2 properties
ChatCompletionMessageToolCall
A call to a function tool created by the model.
Record_string.any_
object
Construct a type with a set of properties K of type T
ChatCompletionMessage.Annotation.URLCitation
object
A URL citation when using web search.
4 properties 4 required
ChatCompletionMessageFunctionToolCall
object
A call to a function tool created by the model.
3 properties 3 required
ResultSuccess_string_
object
2 properties 2 required
ResultError_string_
object
2 properties 2 required
ChatCompletionMessageCustomToolCall
object
A call to a custom tool created by the model.
3 properties 3 required
ResultSuccess_boolean_
object
2 properties 2 required
CompletionUsage
object
Usage statistics for the completion request.
5 properties 3 required
ChatCompletion
object
Represents a chat completion response returned by model, based on the provided input.
8 properties 5 required
ChatCompletionAudio
object
If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://platform.openai.com/docs/gui…
4 properties 4 required
Result_boolean.string_
ChatCompletionMessage.FunctionCall
object
2 properties 2 required
ChatCompletionMessage
object
A chat completion message generated by the model.
7 properties 3 required
Result_ChatCompletion-or-_content-string--reasoning-string--calls-any_.string_
ChatCompletion.Choice
object
4 properties 4 required
ChatCompletion.Choice.Logprobs
object
Log probability information for the choice.
2 properties 2 required
Record_string.number_
object
Construct a type with a set of properties K of type T
ChatCompletionMessageFunctionToolCall.Function
object
The function that the model called.
2 properties 2 required
ChatCompletionTokenLogprob
object
4 properties 4 required
ChatCompletionMessage.Annotation
object
A URL citation when using web search.
2 properties 2 required
ChatCompletionTokenLogprob.TopLogprob
object
3 properties 3 required
Result_string.string_

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-playground-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 Playground 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.