openapi: 3.1.0
info:
  title: Determine Gender from Name API
  description: >
    This API analyzes an individual name and determines the likely gender based on extensive data and algorithms.

    To use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).

    For more information about this API, visit the [Determine Gender from Name API Documentation](https://www.interzoid.com/apis/determine-gender-from-name).

  version: 1.0.0
  contact:
    name: Interzoid Support
    url: https://www.interzoid.com
    email: support@interzoid.com
externalDocs:
  description: API home page and documentation
  url: https://www.interzoid.com/apis/determine-gender-from-name
servers:
  - url: https://api.interzoid.com
    description: Production server
tags:
  - name: Gender Determination
    description: Determines the likely gender associated with a given first name.
paths:
  /getgender:
    get:
      operationId: getGenderFromName
      tags:
        - Gender Determination
      summary: Determine Gender from First Name
      description: >
        Analyzes a given first name to determine the likely gender. Include your API key (license) in the request. Register for an API key at https://www.interzoid.com/register-api-account.
      parameters:
        - name: license
          in: query
          required: true
          description: >
            Your API license key. Register for an API key at
            [Interzoid Registration](https://www.interzoid.com/register-api-account).
          schema:
            type: string
          examples:
            license:
              summary: API Key Example
              value: "fh5hs7*****"
        - name: name
          in: query
          required: true
          description: The first name for which the gender is determined.
          schema:
            type: string
          examples:
            name:
              summary: Name Example
              value: "Pierre Bonaparte"
      responses:
        '200':
          description: Successful response containing the determined gender.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Gender:
                    type: string
                    description: The determined gender for the provided name (e.g., "Male", "Female").
                  Credits:
                    type: integer
                    description: Remaining credits for your API license.
                  Code:
                    type: string
                    description: Response code, "Success" if the call is successful.
              examples:
                success:
                  value:
                    Gender: "Male"
                    Credits: 47372
                    Code: "Success"
        '400':
          description: Bad request (e.g., missing or invalid parameters).
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Invalid license key or name missing."
        '402':
          description: API key not found.
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "API key not found."
        '403':
          description: Insufficient API credits remaining.
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Insufficient API credits remaining."
        '405':
          description: Method not allowed.
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Method not allowed."
        '429':
          description: Rate limits reached.
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Rate limits reached."
        '500':
          description: Internal server error.
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Internal server error."
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: license
      in: query
  schemas: {}
security:
  - apiKeyAuth: []