Helicone Agent API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agent. 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
9 operations
across 8 paths,
and defines 35 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/.
9 operations8 paths35 schemas1 DELETE2 GET6 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 Agent API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Across 8 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Agent 9
POST
/v1/agent/generate
Generatebody→ 200
POST
/v1/agent/thread/{sessionId}/message
UpsertThreadMessage1 parambody→ 200
DELETE
/v1/agent/thread/{sessionId}
DeleteThread1 param→ 200
GET
/v1/agent/thread/{sessionId}
GetThread1 param→ 200
POST
/v1/agent/thread/{sessionId}/escalate
EscalateThread1 param→ 200
POST
/v1/agent/thread/create-and-escalate
CreateAndEscalateThread→ 200
POST
/v1/agent/thread/{sessionId}/reopen
ReopenThread1 param→ 200
GET
/v1/agent/threads
GetAllThreads→ 200
POST
/v1/agent/mcp/search
SearchDocsbody→ 200
Schemas 35
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are OpenAIChatRequest (31 properties), InAppThread (9 properties), ThreadSummary (8 properties), ChatCompletion (8 properties). Each schema is shown below with its type and property counts.
Simplified interface for the OpenAI Chat request format
31 properties
ChatCompletionMessage
object
A chat completion message generated by the model.
7 properties3 required
InAppThread
object
9 properties9 required
ChatCompletionMessageCustomToolCall
object
A call to a custom tool created by the model.
3 properties3 required
ResultSuccess__success-boolean__
object
2 properties2 required
ChatCompletionMessage.Annotation.URLCitation
object
A URL citation when using web search.
4 properties4 required
ChatCompletionTokenLogprob
object
4 properties4 required
Result_InAppThread.string_
ResultSuccess_InAppThread_
object
2 properties2 required
Result__success-boolean_.string_
Record_string.any_
object
Construct a type with a set of properties K of type T
ChatCompletionMessageCustomToolCall.Custom
object
The custom tool that the model called.
2 properties2 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 properties4 required
ChatCompletionMessageFunctionToolCall.Function
object
The function that the model called.
2 properties2 required
Result_string.string_
ChatCompletion
object
Represents a chat completion response returned by model, based on the provided input.
8 properties5 required
ChatCompletionMessageFunctionToolCall
object
A call to a function tool created by the model.
3 properties3 required
ChatCompletionTokenLogprob.TopLogprob
object
3 properties3 required
CompletionUsage.PromptTokensDetails
object
Breakdown of tokens used in the prompt.
2 properties
ChatCompletion.Choice.Logprobs
object
Log probability information for the choice.
2 properties2 required
ChatCompletionMessage.FunctionCall
object
2 properties2 required
Result_ThreadSummary-Array.string_
ResultSuccess_ThreadSummary-Array_
object
2 properties2 required
Record_string.number_
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
Record_string.string_
object
Construct a type with a set of properties K of type T
