openapi: 3.1.0
info:
  title: Determine Entity Type API
  description: >
    This API determines the entity type (e.g., Location, Person, Organization) of a given text input using advanced algorithms and knowledge bases.

    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 Entity Type API Documentation](https://www.interzoid.com/apis/determine-entity-type).
  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-entity-type
servers:
  - url: https://api.interzoid.com
    description: Production server
tags:
  - name: Entity Type Determination
    description: Identifies the type of entity represented by a given text input.
paths:
  /getentitytype:
    get:
      operationId: getEntityType
      tags:
        - Entity Type Determination
      summary: Determine Entity Type from Text
      description: >
        Determines the entity type (e.g., Location, Person, Organization) for a given text input. 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: text
          in: query
          required: true
          description: The text input for which the entity type is determined.
          schema:
            type: string
          examples:
            text:
              summary: Text Input Example
              value: "Argentina"
      responses:
        '200':
          description: Successful response containing the entity type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Result:
                    type: string
                    description: The determined entity type (e.g., Location, Person, Organization).
                  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:
                    Result: "Location"
                    Code: "Success"
                    Credits: 16462
        '400':
          description: Bad request (e.g., missing or invalid parameters).
          content:
            text/plain:
              schema:
                type: string
              examples:
                error:
                  value: "Invalid license key or text input 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: []