openapi: 3.0.1
info:
  title: BrowserOp
  description: When a user enters a webpage link as input, BrowserOp effectively extracts essential webpage information such as HTML metadata, title, and content. Moreover, if a user wishes to retrieve real-time content, BrowserOp employs the real-time search engine to provide relevant and immediate information based on the user's input.
  version: 'v1'
servers:
  - url: https://testplugin.feednews.com
paths:
  /openapi/browser/transcoder:
    post:
      operationId: transcodeWebPage
      summary: Acquire precise webpage details or real-time search engine responses based on user-input content.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transcodeWebPageRequest'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transcodeWebPageResponse'

components:
  schemas:
    transcodeWebPageResponseResult:
      type: object
      properties:
        title:
          type: string
          description: The title of this web page.
        content:
          type: string
          description: The content of the web page's url to be summarized or returned searches.
        metas:
          type: array
          description: The Html metas info of the web page.
          items:
            type: string
        links:
          type: array
          description: Some links in the web page.
          items:
            type: string
        rules:
          description: Adherence is required when outputting content.
          items:
            type: string

    transcodeWebPageResponse:
      type: object
      properties:
        code:
          type: integer
          description: Response status code, '0' means success, '1' means failure.
          example: 0
        result:
          $ref: '#/components/schemas/transcodeWebPageResponseResult'

    transcodeWebPageRequest:
      type: object
      properties:
        link:
          type: string
          description: This parameter takes either a URL or a non-URL string. If a URL is given, the model will engage with the designated webpage to collect or interact with its data. If a non-URL string is given, the model will handle it as a search inquiry and try to find related real-time news or information. To guarantee the best results, make sure the input is a valid URL or a succinct search query.
          required: true