Public API — Getting Started

The Appzi Public API is served at https://portal.api.appzi.io/api/v1 and documented on the API Reference.

Create an API key

In the portal, go to Settings → API Keys and click Create API key. Give it a label (e.g. “Triage agent”).

The full key is shown once. Copy it to your secret manager before closing the dialog. Afterward, only the prefix is visible (e.g. apk_a1b2c3d4…).

If a key leaks — committed to git, pasted in a log, shared by mistake — revoke it from the same page and issue a new one.

Authenticate

Send the key as a Bearer token:

Authorization: Bearer apk_a1b2c3d4...

One key, one portal. Keys cannot access data in other portals.
Revoked keys return 401 Unauthorized.
Use server-side only. A key in browser JavaScript is exposed to every visitor.

First request

curl https://portal.api.appzi.io/api/v1/feedback?pageSize=5 \
  -H "Authorization: Bearer apk_..."

Rate limits

60 requests per minute per key. Over the limit: 429 Too Many Requests with Retry-After: 60.

For bulk tagging, use POST /feedback/batch-tag — a single request tags up to 500 items.

The Cookbook ships an end-to-end auto-tagging workflow as a drop-in agent skill.