hanzoai #

The Dart client for the Hanzo Cloud API at api.hanzo.ai — every operation, projected from the API's own OpenAPI document.

Install #

Not on pub.flutter-io.cn yet. Depend on it by git:

dependencies:
  hanzoai:
    git:
      url: https://github.com/hanzo-dart/sdk.git

Or work on it directly:

git clone https://github.com/hanzo-dart/sdk.git
cd sdk
dart pub get
dart analyze
dart test

Dart 3.0 or newer. The only runtime dependencies are http, collection, intl and meta.

Quickstart #

import 'package:hanzoai/hanzoai.dart';

Future<void> main() async {
  final client = hanzo(token: 'sk-...');

  final keys = await KeysApi(client).getKeys();
  for (final key in keys!.keys) {
    print('${key.type} created ${key.createdAt}');
  }
}

Each tag in the document is one API class — KeysApi, ModelsApi, IamApi, AgentsApi and the rest — and each takes an ApiClient. Omit it and the class uses defaultApiClient, which reaches api.hanzo.ai unauthenticated.

Auth #

One credential, sent as Authorization: Bearer <token>. It is either an access token minted by Hanzo IAM or an API key — pk- publishable, sk- secret.

final client = hanzo(token: 'sk-...');            // authenticated
final open = hanzo();                             // no credential
final local = hanzo(token: t, base: 'http://localhost:3000');

Every operation requires it unless the document says otherwise; a handful are open, and GET /v1/models is one — example/models.dart runs against the live API with no credential at all.

Two shapes of call #

Every operation generates twice.

final keys = await KeysApi(client).getKeys();                  // typed
final res = await ModelsApi(client).getModelsWithHttpInfo();   // raw Response

The typed method is what you want. Some operations publish no response body to type — they declare no response at all, or a 2xx carrying no content — so their typed method returns void and the WithHttpInfo variant is how you read the body. example/models.dart shows that path; example/keys.dart shows the typed one.

Failures above 400 throw ApiException, carrying code and message.

Examples #

• example/quickstart.dart — the block above, as a file the analyzer keeps honest.
• example/models.dart — the model catalogue, no credential, runs as written.
• example/keys.dart — the caller's own API keys, typed, reading the credential from HANZO_API_KEY or ~/.hanzo/config.json.

Where this comes from #

lib/ is generated and nothing in it is edited by hand. .spec-lock names the commit and the sha256 of the openapi.yaml this client is a projection of; scripts/generate.sh rebuilds it from that document, and ./scripts/generate.sh --check fails if the committed tree has drifted from it.

lib/hanzoai.dart is the exception — the front door, written by hand, holding hanzo() and re-exporting the rest.

To change a name in the output, change it in the dart row of hanzoai/openapi sdks.yaml and regenerate.

The other two Dart packages #

• hanzo-dart/hanzoai — a hand-written client for agents, sessions and machines. Its agent and session routes are in the document, so they are in here too. Its five /v1/cloud/*-machine calls are not, so that client is still how you reach them.
• hanzo-dart/base — a different API: Hanzo Base, the reactive backend.

License #

MIT © Hanzo AI, Inc. See LICENSE.