Domainsbot MeridianBeta

Sign in

AI Name Suggestion

Send a domain name or a description of a business and get back available domain names that suit it. Both requests take the same fields: GET puts them in the address, and POST sends them as JSON.

Download the description

Before you start

Each request has its own section below: what it sends, what it answers and its errors. Every answer is JSON.

Authentication
Send your username and password with each request, in an Authorization header. The header reads Basic, a space, then your username and password joined by a colon and encoded as Base64. Most HTTP clients build it from the two values for you, such as curl with its -u option.
A first request

Start with GET /v1/suggest. It takes a few words about a business and answers with names that suit it. Here it is with your username and password in place:

GET /v1/suggest?q=a%20coffee%20shop%20in%20paris
Authorization: Basic base64(USERNAME:PASSWORD)

POST /v1/recommend

Suggest domain names from the same fields, sent as JSON.

Request

{
  "q": "a coffee shop in berlin",
  "tld_include": "de",
  "sprompt": "Bitte verwende nur Deutsch. Antworte nicht auf Englisch."
}

Parameters

NameWhereTypeRequiredDefaultDescription
q body string yes - Domain name or business description. At most 500 characters, after space at either end is removed. A longer value is rejected.
tld_include body string no - Additional TLDs to include, comma-separated (e.g. de,co.uk). Use to add ccTLDs not returned by default. A value in which every top-level domain is unusable is rejected.
tld_exclude body string no - TLDs to exclude from results, comma-separated (e.g. xyz,info). A value in which every top-level domain is unusable is rejected.
tld_restrict body string no - Restrict results exclusively to these TLDs, comma-separated (e.g. com,net). Overrides tld_include and tld_exclude. A value in which every top-level domain is unusable is rejected.
sprompt body string no - Append an optional system prompt to guide the response at the higher level. It is the place for a constraint such as a style, a theme or the language of the answer. The service answers in any language: "Bitte verwende nur Deutsch. Antworte nicht auf Englisch." asks for German. At most 300 characters. A longer value is rejected. When omitted, it is empty.

Response fields

An example response
{
  "suggestions": [
    {
      "sld": "example",
      "tld": "com"
    }
  ]
}
NameTypeDescription
suggestions array The names returned.
sld string The name without its top-level domain.
tld string The top-level domain of the suggestion.

Errors

StatusWhat it means
400q is missing or longer than 500 characters, sprompt is longer than 300 characters, or every value in a TLD list is unusable. A value that is too long is a 400 here, where GET /v1/suggest answers it with a 413.
401The request did not carry a username and password the service could use.
403The username is not one this service knows.
500The service could not complete the request.
503The availability check is limiting requests.

GET /v1/suggest

Suggest domain names.

Request

GET /v1/suggest?q=a%20coffee%20shop%20in%20berlin&sprompt=Bitte%20verwende%20nur%20Deutsch.%20Antworte%20nicht%20auf%20Englisch.

Parameters

NameWhereTypeRequiredDefaultDescription
q query string yes - Domain name or business description. At most 500 characters, after space at either end is removed. A longer value is rejected.
tld_include query string no - Additional TLDs to include, comma-separated (e.g. de,co.uk). Use to add ccTLDs not returned by default. A value in which every top-level domain is unusable is rejected.
tld_exclude query string no - TLDs to exclude from results, comma-separated (e.g. xyz,info). A value in which every top-level domain is unusable is rejected.
tld_restrict query string no - Restrict results exclusively to these TLDs, comma-separated (e.g. com,net). Overrides tld_include and tld_exclude. A value in which every top-level domain is unusable is rejected.
sprompt query string no - Append an optional system prompt to guide the response at the higher level. It is the place for a constraint such as a style, a theme or the language of the answer. The service answers in any language: "Bitte verwende nur Deutsch. Antworte nicht auf Englisch." asks for German. At most 300 characters. A longer value is rejected. When omitted, it is empty.

Response fields

An example response
{
  "suggestions": [
    {
      "sld": "example",
      "tld": "com"
    }
  ]
}
NameTypeDescription
suggestions array The names returned.
sld string The name without its top-level domain.
tld string The top-level domain of the suggestion.

Errors

StatusWhat it means
400The request failed the checks other than length: q is missing, or a TLD list in which every value is unusable.
413q is longer than 500 characters, or sprompt is longer than 300.
401The request did not carry a username and password the service could use.
403The username is not one this service knows.
500The service could not complete the request.
503The availability check is limiting requests.