API Reference

Hutly API Reference

The Hutly Platform exposes a REST API for building on top of agents, conversations, knowledge bases, workflows, PropertyData, and integrations. This reference is for developers integrating with Hutly programmatically.

Quick Start

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.intellia.com.au/orgs/{organizationId}/agents

Base URL

https://api.intellia.com.au

The API host is api.intellia.com.au. The web app moved to app.hutly.com (with app.intellia.com.au redirecting there), but the API hostname is unchanged — keep using api.intellia.com.au.

Authentication

Every request carries an Authorization: Bearer <token> header. Tokens are either long-lived API keys (server-to-server) or short-lived assume-role tokens (embedded / end-user flows). See Authentication for the full model.

Prefer the terminal or CI/CD? The same API is available through the Hutly CLI — the same org-scoped API key authenticates both.

Core Concepts

Organizations — the top-level container; every resource path is scoped under /orgs/{organizationId}/… and every token is bound to exactly one organization.
Agents — AI assistants with their own instructions, model, and attached tools / knowledge bases / sub-agents.
Conversations — chat sessions between a user and an agent.
Knowledge Bases — document collections for retrieval-augmented generation.
Action Chains — multi-step automations agents can run.
PropertyData — Australian property, CMA, and suburb data for licensed orgs.

Sections

Resources

User Management — organizations, users, groups, roles
Agents — configure AI agents
Conversations — manage chat sessions
Knowledge Bases — document management
PropertyData — property, CMA, and suburb data
Prompts — reusable system prompts
Action Chains — automated workflows
Tables — custom data tables
Artifacts — pin/unpin/rename/reorder Apps, app-manifest approval

Integrations

Webhooks — receive and send event notifications
Schedules — run scheduled tasks
Embedded Chat & SSO — embed Hutly chat, SSO, ABN lookup

Conventions

Content type

Send Content-Type: application/json on every POST/PUT request.

Pagination

List endpoints accept:

limit — results per page (default: 20, max: 100)
cursor — pagination offset for the next page

GET /orgs/{organizationId}/conversations?limit=50&cursor=0

Responses include pagination metadata:

{
  "items": [],
  "nextToken": 50,
  "limit": 50
}

Some older list endpoints return { "items": [], "totalRows": N, "offset": N } instead of nextToken. Each resource page documents the exact shape it returns.

Rate limiting

Throughput is governed by your organization’s credit balance rather than a fixed request-per-second cap. Requests that would consume credits fail with 402 when the balance is exhausted. Contact support for limits specific to your plan.

Errors

Errors use standard HTTP status codes with a JSON body:

{
  "message": "Error description"
}

See Error Handling for the full status-code table.

Getting Help

Email: support@hutly.com
Documentation: docs.intellia.com.au