SDK and OpenAPI#

The Hightop Agent SDK is npm-distributed, but package name, install command, release cadence, and recommended version pinning are still pending. Do not hard-code package details until Hightop publishes them.

SDK Error Helpers#

The generated TypeScript SDK includes helpers for Agent API errors:

typescriptexample

const agentError = getAgentApiError(error)
 
if (agentError && isAgentErrorCode(agentError, 'quote_expired')) {
  console.log(agentError.details.quote_id)
}
 
const rateLimit = getAgentApiErrorByCode(error, 'rate_limited')
if (rateLimit) {
  console.log(rateLimit.details.limit_count)
}

Helpers:

getAgentApiError(error)
getAgentApiErrorByCode(error, code)
isAgentErrorCode(error, code)

HightopAgentSDKError(status, response) keeps the existing constructor, message, and code behavior, and exposes agentError when the response matches the Agent API error shape.

OpenAPI#

The Agent API OpenAPI document is exposed at:

textexample

GET /v1/agent/openapi.json

This endpoint is public when the agent_api_v1 feature flag is enabled. It may return 404 while the flag is disabled.

Generated OpenAPI artifacts may include legacy agent-callable shared routes such as /actions/* and /info/*. Use the /v1/agent/* catalog and capabilities as the Agent API v1 contract surface.

Generated artifacts should be regenerated and structurally validated before automated OpenAPI publishing.