{
  "openapi": "3.0.1",
  "info": {
    "title": "Brand & Business Name Generator · Verified Domains, Handles",
    "description": "Brand, business and startup name generator with a built-in username and domain availability checker: every candidate verified live on domains (with prices), 37 social and developer handles, App Store and Wikipedia. Keep only names free where you need them. First 3 names free each month.",
    "version": "1.0",
    "x-build-id": "4uDit70hw7Z22OUwf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/agentsgearbox~brand-name-generator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-agentsgearbox-brand-name-generator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/agentsgearbox~brand-name-generator/runs": {
      "post": {
        "operationId": "runs-sync-agentsgearbox-brand-name-generator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/agentsgearbox~brand-name-generator/run-sync": {
      "post": {
        "operationId": "run-sync-agentsgearbox-brand-name-generator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "brief": {
            "title": "What are you naming?",
            "type": "string",
            "description": "Describe the product, company or project: what it does, who it is for, the tone you want. The AI invents candidate names from this and every candidate is verified live. Leave empty if you only want to check your own names (see Names to check)."
          },
          "names": {
            "title": "Names to check (check-only mode)",
            "type": "array",
            "description": "Your own candidate names. When given, nothing is generated: each name is checked across the selected domains, platforms and collision sources and returned with its availability map.",
            "items": {
              "type": "string"
            }
          },
          "requireFreeOn": {
            "title": "Return only names free on",
            "type": "array",
            "description": "Channel ids a name must be FREE on to be returned, e.g. [\"com\", \"x\", \"github\"]. Use TLDs for domains (com, io, it) and platform ids for handles (x, youtube, github, …). Without this filter every checked candidate is returned with its full availability map, including names that are taken everywhere. AI agents: set this filter when you need names the user can actually register; the generator keeps producing candidates until it has maxResults names that pass. An unknown status never passes the filter.",
            "items": {
              "type": "string"
            }
          },
          "minFreeChannels": {
            "title": "Or: minimum number of free channels",
            "minimum": 0,
            "maximum": 60,
            "type": "integer",
            "description": "Softer alternative to requireFreeOn: return names free on at least this many of the checked channels (domains + platforms + collision sources). 0 disables it. Combined with requireFreeOn, both must hold.",
            "default": 0
          },
          "maxResults": {
            "title": "Names to return",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Stop after this many names were returned (that is, passed the filter when one is set).",
            "default": 10
          },
          "tlds": {
            "title": "Domain extensions to check",
            "type": "array",
            "description": "TLDs to check for every candidate, without the dot. 1,200+ extensions are supported through the registries' RDAP service; .io and .it use WHOIS; extensions without a public registry service fall back to DNS (status marked with method \"dns\"). Registration prices are attached when available.",
            "default": [
              "com"
            ],
            "items": {
              "type": "string"
            }
          },
          "platforms": {
            "title": "Handles to check",
            "type": "array",
            "description": "Social, creator and developer platforms whose handle or namespace is checked for every candidate. All of these are checked without a login or proxy. Instagram, Reddit, Medium and Product Hunt need proxies and are not available yet.",
            "items": {
              "type": "string",
              "enum": [
                "x",
                "youtube",
                "tiktok",
                "twitch",
                "snapchat",
                "telegram",
                "bluesky",
                "mastodon",
                "linkedin",
                "vimeo",
                "dribbble",
                "soundcloud",
                "flickr",
                "giphy",
                "strava",
                "goodreads",
                "steam",
                "hackernews",
                "kick",
                "gumroad",
                "buymeacoffee",
                "aboutme",
                "substack",
                "blogger",
                "devto",
                "huggingface",
                "slack",
                "shopify",
                "github",
                "githubpages",
                "dockerhub",
                "npm",
                "pypi",
                "crates",
                "rubygems",
                "packagist",
                "netlify"
              ],
              "enumTitles": [
                "X (Twitter) handle",
                "YouTube @handle",
                "TikTok @handle",
                "Twitch channel",
                "Snapchat username",
                "Telegram @username (user, channel or bot)",
                "Bluesky handle (name.bsky.social)",
                "Mastodon (mastodon.social) account",
                "LinkedIn company page slug",
                "Vimeo user",
                "Dribbble user",
                "SoundCloud user",
                "Flickr user",
                "Giphy user",
                "Strava athlete",
                "Goodreads user",
                "Steam vanity URL",
                "Hacker News user",
                "Kick channel",
                "Gumroad store (name.gumroad.com)",
                "Buy Me a Coffee page",
                "About.me page",
                "Substack (name.substack.com)",
                "Blogger (name.blogspot.com)",
                "DEV Community user",
                "Hugging Face user or org",
                "Slack workspace (name.slack.com)",
                "Shopify store (name.myshopify.com)",
                "GitHub user or organization",
                "GitHub Pages (name.github.io)",
                "Docker Hub user",
                "npm package",
                "PyPI package",
                "crates.io crate",
                "RubyGems gem",
                "Packagist vendor",
                "Netlify site (name.netlify.app)"
              ]
            },
            "default": [
              "x",
              "youtube",
              "tiktok",
              "telegram",
              "github",
              "linkedin",
              "bluesky",
              "substack",
              "npm"
            ]
          },
          "collisions": {
            "title": "Check for obvious conflicts",
            "type": "boolean",
            "description": "Also check whether an app with exactly this name exists on the Apple App Store (channel id appstore), whether the name has an English Wikipedia article (wikipedia) and whether it is an English dictionary word (dictionary). These are collision checks: \"taken\" means a conflict exists.",
            "default": true
          },
          "style": {
            "title": "Naming style",
            "enum": [
              "mixed",
              "coined",
              "blends",
              "real-words",
              "short"
            ],
            "type": "string",
            "description": "What kind of names the AI should invent. Coined and blended names are far more likely to be free than real words.",
            "default": "mixed"
          },
          "languages": {
            "title": "Must sound good in",
            "type": "array",
            "description": "Languages the names must be easy to pronounce in. Names are always ASCII letters only.",
            "default": [
              "English"
            ],
            "items": {
              "type": "string"
            }
          },
          "minLength": {
            "title": "Minimum length",
            "minimum": 2,
            "maximum": 20,
            "type": "integer",
            "description": "Shortest accepted name (letters).",
            "default": 4
          },
          "maxLength": {
            "title": "Maximum length",
            "minimum": 3,
            "maximum": 30,
            "type": "integer",
            "description": "Longest accepted name (letters).",
            "default": 10
          },
          "mustContain": {
            "title": "Must contain one of",
            "type": "array",
            "description": "Optional fragments; every generated name contains at least one of them (e.g. [\"tab\", \"book\"]).",
            "items": {
              "type": "string"
            }
          },
          "avoid": {
            "title": "Avoid",
            "type": "array",
            "description": "Fragments or words the names must not contain (e.g. competitor names).",
            "items": {
              "type": "string"
            }
          },
          "maxCandidates": {
            "title": "Maximum candidates to generate",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Safety cap on how many names the AI may invent and check in one run while looking for names that pass the filter (rounds of 40). The run also stops early after three rounds without a single match. Only returned names are charged.",
            "default": 200
          },
          "includePrices": {
            "title": "Attach domain registration prices",
            "type": "boolean",
            "description": "Adds the first-year registration price (USD, from a public registrar price list) to every free domain.",
            "default": true
          },
          "concurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "How many checks run at the same time. Lower it if a platform starts returning unknown statuses.",
            "default": 12
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}