Ask the regfish assistant
GET /help/searchOperation ID: SearchHelp
Put a question to Flossi, the regfish assistant, and get back the answer it would give in the dashboard chat. Same assistant, same knowledge base (help center articles, curated procedures, the service FAQ derived from the console itself, the legal pages and the developer documentation), same access to the account behind the API key.
Ask it before describing a click path: the assistant knows the exact menu names, and those are what invented instructions get wrong. It also answers questions no article covers, because they are about this account: when a domain expires, which domains have no DNSSEC, whether anything is unpaid.
Account data follows the key’s own permissions. A key with domain:read gets domain answers; billing answers need billing:read, certificate answers need tls:read. Without the right the assistant leaves that part out rather than refusing the whole question.
The answer is Markdown and may link places in the dashboard as relative paths (/my/…). Resolve them against dashboard_url from the response.
One question at a time: the assistant runs on a single local GPU. A busy assistant answers 503, and so does one that cannot be reached. Rate limit: 10 questions per minute and API key, 20 per 10 minutes and account.
Query parameters
Section titled “Query parameters”| Name | Type | Required | Description |
|---|---|---|---|
q | string | yes | 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?”). |
locale | string | no | Answer language and the regfish world the assistant links to. Omitted, it answers in the language of the question and links to regfish.com. |
Responses
Section titled “Responses”| Status | Type | Description |
|---|---|---|
200 | helpSearchResponse | The assistant’s answer |
400 | Error | Missing or invalid query |
401 | Error | Unauthorized |
403 | Error | Assistant not available for this credential or account |
429 | Error | Too many questions |
500 | Error | Unexpected error |
503 | Error | Assistant busy or unreachable, retrying later is worth it |
Response body
Section titled “Response body”| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | Success indicator |
code | integer | no | Response/Error Code |
response | helpSearchResponse | no | - |
Example
Section titled “Example”curl -X GET "https://api.regfish.com/help/search" \ -H "x-api-key: $REGFISH_API_KEY"Build a request
Section titled “Build a request”Fill in values - the call below updates as you type. Nothing is sent: the API does not currently allow browser requests from this domain (CORS). The API key is not stored.