# AI Domain Finder

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/domains/ai-finder:
    post:
      summary: AI Domain Finder
      deprecated: false
      description: >-
        Generate AI-suggested available domains based on keywords. First call
        starts generation, subsequent polls return progress and results. 


        Domains get stored in cache for 5 minutes, you may generate more after 5
        minutes.
      tags:
        - domains
      parameters:
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: YOUR_API_KEY
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: true
          example: GOOGLE
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                keywords:
                  type: array
                  items:
                    type: string
                tlds:
                  type: array
                  items:
                    type: string
                desiredCount:
                  type: integer
              required:
                - keywords
                - tlds
                - desiredCount
            example:
              keywords:
                - tech
                - startup
              tlds:
                - com
                - io
                - co
              desiredCount: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                      progress:
                        type: integer
                      domains:
                        type: array
                        items:
                          type: string
                      totalDomains:
                        type: integer
                    required:
                      - status
                      - progress
                      - domains
                      - totalDomains
                    x-apidog-orders:
                      - status
                      - progress
                      - domains
                      - totalDomains
                required:
                  - success
                  - message
                  - data
                x-apidog-orders:
                  - success
                  - message
                  - data
              example: >-
                { "success": true, "message": "AI domain suggestions retrieved
                successfully", "data": { "status": "completed", "progress": 100,
                "domains": [...], "totalDomains": 10 } }
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: domains
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-26765390-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```