---
title: "Generate Domain Names"
method: POST
path: "/provider-domains/generate-domains"
tags: ["Provider Domains"]
---

# Generate Domain Names

`POST /provider-domains/generate-domains`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/provider-domains/generate-domains`
- Auth: HTTP bearer

Suggest buyable domain names around a keyword. SPENDS NOTHING.

A naming aid, not a reservation: a name returned here can still be gone by
the time you buy it, so `check-availability` remains the authority.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- DomainNameGenerateRequest: Suggest buyable domain names around a keyword. SPENDS NOTHING.
  - `keyword` string, required: Seed word the generated names are built around, e.g. 'acme'
  - `count` integer: How many suggestions to return
  - `prefixes` string, nullable: Comma-separated prefixes to try, e.g. 'get,try'
  - `suffixes` string, nullable: Comma-separated suffixes to try, e.g. 'hq,mail'
  - `provider` 'registrar' | 'managed' | 'pilot': Provisioning path to generate for

## Response `200`

Successful Response

- ApiResponseMailboxDomainPayload
  - `data` MailboxDomainPayload, required: An open envelope for one provider/deliverability result. Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as "nothing to report" rather than "we did not tell you". Every value passes through ``scrub_vendor_names`` on the way in.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)