Ask the regfish assistant | regfish DNS & TLS API

GET

/help/search

Help

Authentifizierung

x-api-key

SchnellstartAuthentifizierung Regfish ConsoleAPI-Key im Regfish-Interface anlegen und testen

Parameter

Name

Typ

Format

Pflicht

Description

locale

query

string

Optional

Answer language and the regfish world the assistant links to. Omitted, it answers in the language of the question and links to regfish.de.

query

string

Pflicht

The question, in the customer's own words. There is no conversation state: each call stands alone, so a follow-up has to carry its own context ("when does example.de expire?", not "and when does it?").

Request-Beispiel

GET

curl --request GET \
  --url 'https://api.regfish.com/help/search?locale=de&q=example' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200

The assistant's answer

application/jsonhelpSearchResponse

Response-Beispiel 200

{
  "success": true,
  "code": 0,
  "response": {
    "question": "example",
    "answer": "example",
    "truncated": true,
    "sources": "example",
    "dashboard_url": "example"
  }
}

400

Missing or invalid query

application/jsonError

Response-Beispiel 400

{
  "success": false,
  "message": "Missing or invalid query",
  "error": "Missing or invalid query"
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

403

Assistant not available for this credential or account

application/jsonError

Response-Beispiel 403

{
  "success": false,
  "message": "Assistant not available for this credential or account",
  "error": "Assistant not available for this credential or account"
}

429

Too many questions

application/jsonError

Response-Beispiel 429

{
  "success": false,
  "message": "Too many questions",
  "error": "Too many questions"
}

500

Unexpected error

application/jsonError

Response-Beispiel 500

{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}

503

Assistant busy or unreachable, retrying later is worth it

application/jsonError

Response-Beispiel 503

{
  "success": false,
  "message": "Assistant busy or unreachable, retrying later is worth it",
  "error": "Assistant busy or unreachable, retrying later is worth it"
}

Verwandte Modelle

baseResult

Error

helpSearchResponse

Werde ein Teil der Community

Das DNS API von Regfish ist die perfekte Lösung für Entwickler, die ihre Domains und DNS-Zonen automatisieren möchten. Werde Teil der Community und profitiere von den Vorteilen der DNS-Automatisierung. Das DNS API steht jedem Regfish-Kunden kostenlos zur Verfügung.