openapi: 3.0.1
info:
  title: Jini Assistant AI API
  description: Universal plugin for factual, knowledge-base and real-time information. The only smart assistant you'll ever need. Search images, videos, music, apps and facts. Get the latest news, twitter trends, sports scores, (stock) prices, celebrity and country data, navigation routes, public transport and traffic info, etc.…. Acts as a proxy to make ANY information that exists online or privately available to ChatGPT. Five million users via the Siri-like app http://www.voice-actions.com/
  version: 'v1.0'
#  comment: THIS IS THE OLD CLUTTERED API,
#  PLEASE USE THE NEW ONE AT https://api.pannous.com
  contact:
      name: Pannous
      email: info@pannous.com
servers:
  - url: http://localhost:8080
    description: Local test server
  - url: https://api.pannous.com
    description: Production server
paths:
  /?query={query}:
    get:
      operationId: query
      summary: Get realtime data, facts and answers to questions
      parameters:
      - in: path
        name: query
        schema:
            type: string
        required: true
        description: query for any realtime data, such as date, time, news, location, navigation routes, weather, events etc.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queryResponse'

components:
  schemas:
    queryResponse:
      type: object
      description: The response from the Jini Assistant AI API.
      properties:
        output:
          type: array
          description: Array of result outputs for the query.
          items:
            type: object
            description: result output for the query.
            properties:
              handler:
                type: string
              results:
                type: object
                additionalProperties: true
                description: raw answer data or additional (un)structured data
              entities:
                type: object
                properties:
                  input:
                    type: string
                    description: the actual question condensed to extracted entities
                  locale:
                    type: string
                additionalProperties: true
                description: additional properties can include from,to locations in navigation etc
#                  from:
#                    type: string
#                    description:
              actions:
                type: object
                properties:
                  say:
                    type: object
                    properties:
                      text:
                        type: string
                        description: the actual answer!
                  open:
                    type: object
                    properties:
                      url:
                        type: string
                        description: the url to open
                  show:
                    type: object
                    properties:
                      url:
                        type: string
                        description: the url to show
              responseTime:
                type: integer