OpenAPI and Artifacts#

The Agent API ships official, generated tooling. This page covers the generated artifacts and the OpenAPI document; the full guides live on their own pages.

Tooling#

• TypeScript SDK — @hightop/sdk. See TypeScript SDK and the SDK Reference.
• CLI — @hightop/cli (the hightop executable). See CLI and the CLI Command Reference.
• MCP — exposes the Agent API as tools. See MCP and the MCP Tool Reference.

All three are generated from the same Agent API contract, so they stay in lockstep with the Endpoints.

OpenAPI#

The Agent API OpenAPI document is served at:

GET /v1/agent/openapi.json

It is public and unauthenticated, and describes the /v1/agent/* surface. You can fetch it with any tool:

curl -sS https://api.hightop.com/v1/agent/openapi.json

Or through the official tooling:

hightop openapi --pretty

const openapi = await new HightopAgentClient({ baseUrl: 'https://api.hightop.com' }).openapi.get()

Notes on the document#

• Treat the /v1/agent/* catalog and Capabilities as the authoritative v1 surface. Generated OpenAPI output may also include legacy agent-callable /actions/* and /info/* routes; those are not part of Agent API v1.
• The document is regenerated from source schemas, so it always matches the live contract. If you generate your own client from it, regenerate when the contract version changes.

SDK error helpers#

The TypeScript SDK includes helpers for narrowing Agent API errors:

import { getAgentApiError, getAgentApiErrorByCode, isAgentErrorCode } from '@hightop/sdk'
 
const agentError = getAgentApiError(error)
if (agentError && isAgentErrorCode(agentError, 'quote_expired')) {
  console.log(agentError.details.quote_id)
}

HightopAgentSDKError preserves the HTTP status, normalized agentError, original response body, headers, and request id. See TypeScript SDK for the full error and timeout model, and Errors for the stable code list.