Den regfish-Assistenten fragen

GET /help/search

Bezeichner: SearchHelp

Stellt Flossi, dem regfish-Assistenten, eine Frage und liefert die Antwort zurück, die er auch im Dashboard-Chat geben würde. Derselbe Assistent, dieselbe Wissensbasis (Artikel des Hilfe-Centers, kuratierte Anleitungen, die aus der Console selbst abgeleiteten Service-FAQ, die Rechtstexte und die Entwicklerdokumentation), derselbe Zugriff auf den Account hinter dem API-Key.

Vor dem Beschreiben eines Klickpfads besser den Assistenten fragen: Er kennt die genauen Menünamen - und genau die sind es, die frei erfundene Anleitungen falsch wiedergeben. Er beantwortet außerdem Fragen, die kein Artikel abdeckt, weil sie diesen Account betreffen: wann eine Domain abläuft, welche Domains kein DNSSEC haben, ob noch etwas offen ist.

Account-Daten folgen den Rechten des jeweiligen Keys. Ein Key mit domain:read bekommt Antworten zu Domains; Antworten zur Abrechnung brauchen billing:read, Antworten zu Zertifikaten tls:read. Fehlt das Recht, lässt der Assistent diesen Teil weg, statt die ganze Frage abzulehnen.

Die Antwort ist Markdown und kann Stellen im Dashboard als relative Pfade verlinken (/my/…). Diese sind gegen dashboard_url aus der Antwort aufzulösen.

Immer nur eine Frage gleichzeitig: Der Assistent läuft auf einer einzelnen lokalen GPU. Ist er ausgelastet, antwortet er mit 503 - ebenso, wenn er nicht erreichbar ist. Rate-Limit: 10 Fragen pro Minute und API-Key, 20 pro 10 Minuten und Account.

Query-Parameter

Name	Typ	Pflicht	Beschreibung
q	string	ja	Die Frage in den eigenen Worten des Kunden. Es gibt keinen Gesprächszustand: Jeder Aufruf steht für sich, eine Anschlussfrage muss ihren Kontext daher selbst mitbringen („wann läuft example.de ab?“, nicht „und wann läuft die ab?“).
locale	string	nein	Sprache der Antwort und regfish-Welt, auf die der Assistent verlinkt. Ohne Angabe antwortet er in der Sprache der Frage und verlinkt auf regfish.de.

Antworten

Status	Typ	Beschreibung
200	helpSearchResponse	Die Antwort des Assistenten
400	Error	Fehlende oder ungültige Frage
401	Error	Nicht autorisiert
403	Error	Assistent für diese Zugangsdaten oder diesen Account nicht verfügbar
429	Error	Zu viele Fragen
500	Error	Unerwarteter Fehler
503	Error	Assistent ausgelastet oder nicht erreichbar - ein späterer Versuch lohnt sich

Antwortkörper

Feld	Typ	Pflicht	Beschreibung
success	boolean	ja	Erfolgskennzeichen
code	integer	nein	Antwort-/Fehlercode
response	helpSearchResponse	nein	-

Beispiel

curl -X GET "https://api.regfish.com/help/search" \
  -H "x-api-key: $REGFISH_API_KEY"

Anfrage zusammenstellen

Werte eintragen - der Aufruf unten passt sich an. Es wird nichts abgeschickt: die API gibt Browser-Anfragen von dieser Domain aus derzeit nicht frei (CORS). Der API-Key wird nicht gespeichert.