Back to APIs

Unified Agent API

Domains

Domains

Discover brandable domain names, the extensions that fit a business (.coffee, .studio, ...), check exact-name availability across the whole extension catalog, and compare prices, all from one capability.

POST/v1/domainsReal-time

Overview

Find domain names and the extensions that fit a business

Credits

Suggest names: 5, Suggest extensions: 3, Search extensions: 2, Check availability: 1, Pricing: 1, Extension catalog: 1

Providers

Name.comNamecheap

SDK Method

client.domains(...)

Modes

The mode parameter is a preset that configures optimal provider routing for common use cases. You can also set individual parameters directly for fine-grained control.

Suggest names

5 credits

Brandable domain name ideas.

Luna name ideas + domain hacks, each checked for availability and price, filtered by the search options' limits and ranked by their priorities.

Suggest extensions

3 credits

Extensions that fit the business.

The .tld choices that fit what the business does, each with a reason and base price; picks over a price cap are dropped.

Search extensions

2 credits

One name across the catalog.

Availability + price of one exact name across the whole extension catalog, plus domain-hack splits of the name, filtered and ordered by the search options, paged 50 at a time.

Check availability

1 credit

Availability for a domain list.

Availability, premium and EAP status for a list of full domains.

Pricing

1 credit

Comparison price per extension.

Namecheap comparison price for a list of extensions.

Extension catalog

1 credit

The full extension catalog.

Every registrable extension, enriched with length, popularity and theme.

Parameters

mode

select (default: suggest-names)

Which domain capability to run.

Suggest names
Suggest extensions
Search extensions
Check availability
Pricing
Extension catalog
company_name

string

The business name (suggest-extensions), or for suggest-names a natural-language brief: any ordering or limit it states (for example "shortest" or "renewal under $15") is read and applied beneath your explicit search_options.

description

string

What the business does; grounds the fit (suggest-* modes).

company_id

string

Optional O-mega/Founden company id; pulls the real business brief to ground the fit.

purpose

select

What the domain is for (suggest-names / suggest-extensions): website (the site address), cold (a dedicated cold-email domain, kept apart from the site) or extra. Context the model weighs when judging fit; it sets no search options, which are yours to choose (search_options) from what the company needs.

Site address
Cold email
Extra domain
search_options

object

Search options, only the fields you set (suggest-names / search-extensions / suggest-extensions): priorities (objective keys in priority order: total_length, annual_price, renewal_price, registration_total, semantic_fit, brandability, label_length), max_total_length and max_label_length (characters), max_annual_price, max_renewal_price and max_registration_total (USD), hacks (include, exclude or only) and allow_premium (boolean). A field you set wins over what the company_name brief asks for; null (or priorities: []) leaves that field to the brief; unknown keys are rejected. Options that do not apply to a mode are ignored there. The response echoes the effective options (search-extensions: search_options; suggest-names: search_plan.search_options).

query

string

An exact name to check across extensions (search-extensions).

domains

array

Full domains to check, e.g. ["brewhaven.com"] (check-availability).

tlds

array

Extensions to price (pricing), to check the name across (search-extensions), or to restrict name ideas to (suggest-names).

exact_extension

boolean (default: false)

search-extensions: check ONLY the typed extension.

offset

number (default: 0)

search-extensions: pagination offset into the catalog.

Example Response

{
  "success": true,
  "data": {
    "extensions": [
      {
        "tld": "coffee",
        "reason": "Directly identifies a coffee brand.",
        "price": "$32.99/yr"
      }
    ]
  },
  "metadata": {
    "provider_used": "name.com",
    "mode_used": "suggest-extensions",
    "response_time_ms": 1800,
    "request_id": "req_dom123"
  },
  "credits_used": 3
}

Get Started

Create a Suprsonic API key in your dashboard, then call the endpoint with your key in the Authorization header.

Try Domains

Test Domains in the interactive playground. No setup required.

Open Playground