Erste Schritte - Chatarmin CX Docs

In wenigen Minuten vom Nullpunkt zum funktionierenden API-Aufruf.

Voraussetzungen

Chatarmin-CX-Workspace mit Berechtigung für API-Schlüssel (Einstellungen → API)
curl oder ein anderer HTTP-Client (z. B. Postman)

API-Einstellungen öffnen

Schlüssel anlegen

Klicke API-Schlüssel erstellen, vergib einen Namen und wähle Scopes. Für reine Lese-Integrationen und KI-Agenten reicht tickets:read.

Schlüssel kopieren

Kopiere den Schlüssel und speichere ihn in einem Secrets Manager, nicht im Quellcode.

Details zu Scopes und Rotation: Authentifizierung & API-Schlüssel.

curl -sS \
  -H "cx-api-key: DEIN_API_SCHLÜSSEL" \
  "https://api.armin.cx/public/v1/health"

Erwartete Antwort:

{
  "success": true,
  "data": {
    "version": "v1"
  }
}

Der Health-Endpoint braucht einen gültigen Schlüssel, aber keinen bestimmten Scope — gut, um die Auth zu testen, bevor du Ticket-Routen aufrufst.

curl -sS \
  -H "cx-api-key: DEIN_API_SCHLÜSSEL" \
  "https://api.armin.cx/public/v1/tickets?limit=5"

Jede v1-Erfolgsantwort nutzt das Envelope { "success": true, "data": ... }. Listen liefern zusätzlich pagination:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "has_more": true,
    "next_cursor": "2026-07-20T10:00:00.000Z|019b..."
  }
}

Übergib pagination.next_cursor als Query-Parameter cursor für die nächste Seite. Siehe Pagination.

Die meisten Agent-Workflows starten mit gespeicherten Posteingang-Ansichten:

curl -sS \
  -H "cx-api-key: DEIN_API_SCHLÜSSEL" \
  "https://api.armin.cx/public/v1/views"

Wähle eine View-id, dann Tickets mit dieser Ansicht:

curl -sS \
  -H "cx-api-key: DEIN_API_SCHLÜSSEL" \
  "https://api.armin.cx/public/v1/tickets?view_id=VIEW_UUID&limit=40"

Vollständige Endpoint-Referenz mit Schemas und Try it.

Typische KI-Agenten-Muster als API-Aufrufe.