openapi: 3.0.1
# see .well-known/ai-plugin.json
# deployed as http://files.pannous.com/.well-known/ai-plugin.json
# deployed as http://files.pannous.com/openapi.yaml current
# deployed as http://files.pannous.com/v1/openapi.yaml
# deployed as http://files.pannous.com/v2/openapi.yaml
# see https://platform.openai.com/docs/plugins/production/updating-your-plugin
#  Currently, manifest files must be manually updated
#  by going through the "Develop your own plugin" flow in the plugin store each time you make a change to the file.
#  ChatGPT will automatically fetch the latest OpenAPI spec each time a request is made.

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: 'v2.0'
  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}:
    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'

  /download/{url}:
    get:
      operationId: download
      summary: Download data from the internet
      parameters:
        - in: path
          name: url
          schema:
            type: string
          required: true
          description: url to be fetched from the internet by proxy
      responses:
        "200":
          description: OK
          content:
            application/text:
              schema:
                type: string
                description: The raw contents of the file uri url resource downloaded from the internet.

  /summarize/{url}:
    get:
      operationId: summarize
      summary: summarize a page from the internet
      parameters:
        - in: path
          name: url
          schema:
            type: boolean
          required: false
          description: Extract relevant textual information from the data source
      responses:
        "200":
          description: OK
          content:
            application/text:
              schema:
                  type: string
                  description: The extracted textual content of the internet resource.

components:
  schemas:
    queryResponse:
      type: object
      description: The response from the Jini Assistant AI API.
      properties:
        query:
          type: string
          description: the original input question sent to the API
        answer:
          type: string
          description: combined response text from all handlers
        detectedLanguage:
          type: string
        responseTime:
          type: integer
        apiVersion:
          type: string
          description: the version of the API, here constant v2.0
        responses:
          type: array
          description: Array of (raw) result outputs for the query.
          items:
            type: object
            description: result output for the query.
            properties:
              handler:
                type: string
                description: the name of the handler that generated the response
    #              entities:
    #                type: array