📚 Documentation

Complete documentation for PulseDomain AI - API reference, user guide, and technical documentation for the AI-powered domain name generator.

🚀 Getting Started
🔧 API Reference
💡 Examples

🚀 Getting Started

Welcome to PulseDomain AI! This comprehensive guide will help you get started with our AI-powered domain name generator that creates brandable domain suggestions based on current news trends.

🤖

AI-Powered

Uses Google Gemini AI to generate creative, brandable domain names

📰

News-Driven

Analyzes current news trends to suggest relevant domain names

Real-Time

Provides instant domain availability checking and suggestions

🔍

Comprehensive

Includes domain analytics, social media checks, and valuation

Quick Start

  1. Enter a news topic - Type keywords related to current trends
  2. Configure settings - Choose your business focus and preferences
  3. Generate domains - Click the generate button to get AI suggestions
  4. Check availability - Verify which domains are available for registration
  5. Register your domain - Use our Porkbun integration to secure your domain

👤 User Guide

🔑 API Key Configuration

PulseDomain AI requires API keys for optimal functionality:

🤖 Google Gemini API (Required)

Essential for AI-powered domain generation

Get API Key

📰 News APIs (Optional)

Enhance news data quality and coverage

📊 Domain Generation Process

1

News Analysis

Our system fetches and analyzes current news articles based on your topic

2

Trend Extraction

AI identifies trending keywords and concepts from the news content

3

Domain Creation

Gemini AI generates creative, brandable domain names using the trends

4

Availability Check

Real-time verification of domain availability across multiple TLDs

⚙️ Configuration Options

📰 News Settings

  • Time Range: 24 hours, 3 days, week, or month
  • Fetch Depth: Light (titles only) or Deep (full content)
  • Topic Focus: Specific keywords or broad categories

🏢 Business Settings

  • Business Focus: Technology, Startup, E-commerce, SaaS, etc.
  • Domain Count: 1-20 suggestions per generation
  • Word Limit: 1-5 words per domain name

🌐 TLD Preferences

  • Popular TLDs: .com, .io, .ai, .app, .tech, .co
  • Custom Selection: Choose specific extensions
  • Priority Order: Preferred TLDs checked first

🔧 API Reference

Complete API documentation for developers who want to integrate with PulseDomain AI programmatically.

🚀 Domain Generation API

POST /generate

Generate AI-powered domain suggestions based on news trends.

Request Body

{
  "geminiApiKey": "your-gemini-api-key",
  "newsQuery": "artificial intelligence",
  "wordCount": 5,
  "maxDomains": 10,
  "tldPreferences": ".com,.io,.ai",
  "businessFocus": "technology",
  "includeKeywords": true,
  "timeRange": "24h",
  "fetchDepth": "light",
  "mediastackApiKey": "optional-mediastack-key",
  "gnewsApiKey": "optional-gnews-key",
  "newsapiApiKey": "optional-newsapi-key",
  "currentsApiKey": "optional-currents-key"
}

Response

{
  "success": true,
  "suggestions": [
    {
      "domain": "aitrend.com",
      "available": true,
      "tld": ".com",
      "brandability": 8.5,
      "memorability": 9.2,
      "overallScore": 8.8,
      "reasoning": "Combines AI trend focus with memorable branding"
    }
  ],
  "metadata": {
    "newsQuery": "artificial intelligence",
    "articlesFound": 15,
    "generatedAt": "2025-06-26T21:00:00.000Z"
  }
}

🔍 Domain Availability API

GET /check?domain=example.com

Check the availability of a single domain.

Response

{
  "success": true,
  "domain": "example.com",
  "result": {
    "available": false,
    "source": "whois",
    "confidence": "high",
    "checkedAt": "2025-06-26T21:00:00.000Z"
  }
}

📦 Batch Domain Check API

POST /check/batch

Check availability of multiple domains at once.

Request Body

{
  "domains": ["example1.com", "example2.io", "example3.ai"]
}

Response

{
  "success": true,
  "results": [
    {
      "domain": "example1.com",
      "available": false,
      "source": "whois"
    },
    {
      "domain": "example2.io",
      "available": true,
      "source": "whois"
    }
  ],
  "summary": {
    "total": 3,
    "available": 1,
    "unavailable": 2
  }
}

✨ Features

🤖 AI-Powered Generation

  • Google Gemini AI integration
  • Context-aware domain suggestions
  • Brandability scoring algorithm
  • Memorability analysis

📰 News Integration

  • Real-time news fetching
  • Multiple news API support
  • Trend extraction and analysis
  • Configurable time ranges

🔍 Domain Analysis

  • Real-time availability checking
  • WHOIS data integration
  • Social media handle verification
  • Domain valuation estimates

📊 Analytics & Insights

  • Domain performance metrics
  • Market trend analysis
  • Investment potential scoring
  • Comparative domain analysis

💼 Portfolio Management

  • Domain portfolio creation
  • Bulk domain operations
  • Export functionality
  • Performance tracking

🔒 Security & Privacy

  • API key encryption
  • Rate limiting protection
  • Secure data handling
  • Privacy-focused design

⚙️ Configuration

🔐 Environment Variables

Configure PulseDomain AI using environment variables:

# Required
GEMINI_API_KEY=your_gemini_api_key_here

# Optional News APIs
MEDIASTACK_API_KEY=your_mediastack_key
GNEWS_API_KEY=your_gnews_key
NEWSAPI_API_KEY=your_newsapi_key
CURRENTS_API_KEY=your_currents_key

# Server Configuration
PORT=3000
NODE_ENV=production

# Security
SESSION_SECRET=your_session_secret
ENCRYPTION_KEY=your_encryption_key

🎛️ Advanced Settings

Rate Limiting

  • Domain Generation: 10 requests per minute
  • Availability Checks: 30 requests per minute
  • Bulk Operations: 5 requests per minute

Cache Settings

  • Domain Availability: 1 hour TTL
  • News Data: 30 minutes TTL
  • AI Suggestions: 24 hours TTL

API Quotas

  • Gemini AI: 1,500 requests per day
  • News APIs: Varies by provider
  • WHOIS Checks: Unlimited

🔧 Troubleshooting

🚫 API Key Issues

Problem:

"Invalid API key" or "API key required" errors

Solutions:

  • Verify your Gemini API key is correct
  • Check API key permissions and quotas
  • Ensure API key is properly configured
  • Try regenerating your API key

📰 News Data Issues

Problem:

No news articles found or poor quality suggestions

Solutions:

  • Try broader or more specific keywords
  • Adjust time range settings
  • Configure additional news API keys
  • Check news API quotas and limits

🔍 Domain Check Issues

Problem:

Domain availability checks failing or inaccurate

Solutions:

  • Verify domain format is correct
  • Try checking individual domains
  • Wait and retry after a few minutes
  • Check network connectivity

⚡ Performance Issues

Problem:

Slow response times or timeouts

Solutions:

  • Use "Light" fetch depth for faster results
  • Reduce number of domain suggestions
  • Check your internet connection
  • Try during off-peak hours

📋 Common Error Codes

Error Code Description Solution
400 Bad Request - Invalid parameters Check request format and required fields
401 Unauthorized - Invalid API key Verify and update your API key
429 Too Many Requests - Rate limit exceeded Wait before making more requests
500 Internal Server Error Try again later or contact support
503 Service Unavailable Check network connection and retry

💡 Examples

🚀 Tech Startup Domains

Input:

  • Topic: "artificial intelligence startups"
  • Business Focus: Technology
  • TLDs: .com, .ai, .io

Sample Results:

  • aiventure.com - Available ✅
  • smartflow.ai - Available ✅
  • neuralpath.io - Taken ❌
  • cognitivelab.com - Available ✅

🛒 E-commerce Domains

Input:

  • Topic: "sustainable fashion trends"
  • Business Focus: E-commerce
  • TLDs: .com, .shop, .store

Sample Results:

  • ecostyle.shop - Available ✅
  • greenfashion.store - Taken ❌
  • sustainwear.com - Available ✅
  • ethicaltrend.com - Available ✅

💰 Finance Domains

Input:

  • Topic: "cryptocurrency investment"
  • Business Focus: Finance
  • TLDs: .com, .finance, .money

Sample Results:

  • cryptowise.com - Available ✅
  • digitalcoin.finance - Available ✅
  • blockchainvault.com - Taken ❌
  • smartinvest.money - Available ✅

🔧 API Usage Examples

JavaScript/Node.js

const response = await fetch('/generate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    geminiApiKey: 'your-api-key',
    newsQuery: 'artificial intelligence',
    maxDomains: 5,
    businessFocus: 'technology'
  })
});

const data = await response.json();
console.log(data.suggestions);

Python

import requests

response = requests.post('http://localhost:3000/generate', json={
    'geminiApiKey': 'your-api-key',
    'newsQuery': 'artificial intelligence',
    'maxDomains': 5,
    'businessFocus': 'technology'
})

data = response.json()
print(data['suggestions'])

cURL

curl -X POST http://localhost:3000/generate \
  -H "Content-Type: application/json" \
  -d '{
    "geminiApiKey": "your-api-key",
    "newsQuery": "artificial intelligence",
    "maxDomains": 5,
    "businessFocus": "technology"
  }'

📝 Changelog

v1.0.0 2025-06-26

🎉 Initial Release

  • AI-powered domain generation using Google Gemini
  • Real-time news trend analysis
  • Domain availability checking
  • Social media handle verification
  • Domain valuation and analytics
  • Portfolio management system
  • Bulk domain operations
  • Export functionality
  • Responsive web interface
  • Dark/light theme support

🔧 Technical Features

  • RESTful API architecture
  • Rate limiting and security
  • Caching for performance
  • Multiple news API integration
  • Real-time WHOIS checking
  • Comprehensive error handling