HiAgent API and developer resources.

Use the public API, OpenAPI contract, official CLI package, and website widget. Check the exact scope of each interface.

Widget install

Add one workspace-scoped script.

Copy the workspace ID from the signed-in setup flow. Keep widget behavior, sources, and handoff settings in the HiAgent dashboard.

HTML

<script async
  src="https://hiagent.lt/widget.js"
  data-workspace="YOUR_WORKSPACE_ID">
</script>

Public API

Two safe, fully described operations.

Check service health or ask the fixed product demo. These operations need no authentication and never expose customer data.

OpenAPI 3.1 specification
GET service health
POST /api/v1/demo-answer.php

Shell

curl https://hiagent.lt/api/v1/health.php

curl -X POST https://hiagent.lt/api/v1/demo-answer.php \
  -H "Content-Type: application/json" \
  -d '{"question":"How does human handoff work?"}'

Official CLI

Use HiAgent from a terminal.

The hiagent-cli package wraps each public operation. It prints concise text by default and complete JSON with the --json option.

Shell

npm install --global hiagent-cli
hiagent status
hiagent ask "How does human handoff work?"

Published interfaces

Current HiAgent integration status.

This list states what is public. It does not imply that an unpublished interface exists or is ready for customer use.

Website widget

Published

Use the widget loader and the workspace ID supplied by the signed-in HiAgent setup flow.

Public REST API and OpenAPI specification

Published

The versioned public API exposes a health check and deterministic product demo. Its complete OpenAPI 3.1 contract is at /openapi.json.

Public API authentication

Not required

The two public operations do not access customer data. Account and workspace operations remain private and server controlled.

Official HiAgent CLI

Ready for npm

The hiagent-cli package supports public service checks, demo questions, structured errors, and OpenAPI discovery. npm publication requires the HiAgent publisher account.

Webhook specification

Dashboard only

Available automation destinations are configured inside the signed-in workspace. A public webhook specification is not published.

MCP server

Not published

HiAgent does not currently publish a remote MCP server for customer use.

Machine-readable site resources

Need another integration?

Describe the system, event, and data you need. Do not send passwords, API keys, or customer data.

Contact HiAgent