static/api.yaml

---
openapi: 3.0.0
info:
  title: imperialwool's FunAPI
  description: Big API for bots, developers or just fun by @podvaljoey (telegram).
  version: $VERSION_VARIABLE$
servers:
  - url: https://imperialwool-funapi.hf.space/
    description: You are here! ^o^
paths:
  /analyzeText/api/v1/toxicity:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/PredictedToxicityObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - Analyze text API
      parameters:
        - name: text
          description: Text to analyze
          in: lang
          schema:
            type: string
          example: ru
      summary: Classifying a text as toxic or not toxic
      responses: null
  /analyzeText/api/v1/sentiment:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/PredictedSentimentObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - Analyze text API
      parameters:
        - name: text
          description: Text to analyze
          in: lang
          schema:
            type: string
          example: ru
      summary: Classifying a text as negative, positive or neutral
      responses: null
  /jokes/api/v1/get:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/JokeObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - Jokes API
      parameters:
        - name: lang
          description: Language in which to look for a joke. (Now supported only ru, sorry.)
          in: lang
          schema:
            type: string
          example: ru
        - name: source
          description: You can get sources and use one of them, if you like.
          in: source
          schema:
            type: string
          example: chucknorris
      summary: Finding joke by language
      responses: null
  /jokes/api/v1/sources:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/JokeSourceObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - Jokes API
      summary: Showing all possible jokes sources
      responses: null
  /osu/api/v1/find-song:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/FindBeatmapsObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - osu! API
      parameters:
        - name: query
          description: Query to find beatmap.
          in: query
          schema:
            type: string
          example: rickroll
      summary: Finding beatmap by query
      responses: null
  /osu/api/v1/get-full:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/SongFullObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - osu! API
      parameters:
        - name: query
          description: Query to find beatmap and download full song.
          in: query
          schema:
            type: string
          example: rickroll
        - name: beatmapId
          description: Beatset id. Not map, set.
          in: query
          schema:
            type: integer
          example: 1
      summary: Get beatmap's full song
      responses: null
  /osu/api/v1/get-preview:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/SongPreviewObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - osu! API
      parameters:
        - name: query
          description: Query to find beatmap and download full song.
          in: query
          schema:
            type: string
          example: rickroll
        - name: beatmapId
          description: Beatset id. Not map, set.
          in: query
          schema:
            type: integer
          example: 1
      summary: Get beatmap's song preview
      responses: null
  /system/api/v1/info:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/SysinfoObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - System information
      summary: Information about server
      responses: null
  /yt/api/v1/search:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/YTSearchObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - "Youtube: Becoming Music Platform"
      parameters:
        - name: query
          description: Query for YouTube to find videos.
          in: query
          schema:
            type: string
          example: never gonna give you up
      summary: This method can help with searching videos on YouTube
      responses: null
  /yt/api/v1/get-full:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/YTFullObject"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - "Youtube: Becoming Music Platform"
      parameters:
        - name: url
          description: Url to video from YouTube. (TikTok also works sometimes.)
          in: query
          schema:
            type: string
        - name: bitrate
          description: Bitrate of final audio.
          in: query
          schema:
            type: string
          example: 64k
        - name: quality
          description: Quality of final audio. Only 'worst' or 'best'.
          in: query
          schema:
            type: string
          example: worst
      summary: Download video as audio and providing link for you
      responses: null
  /yt/api/v1/get-preview:
    post:
      "200":
        description: OK
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/YTPreviewResult"
      "400":
        description: Bad Request
        content: null
        application/json:
          schema: null
          $ref: "#/components/schemas/ErrorObject"
      tags:
        - "Youtube: Becoming Music Platform"
      parameters:
        - name: url
          description: Url to video from YouTube. (TikTok also works sometimes.)
          in: query
          schema:
            type: string
        - name: bitrate
          description: Bitrate of final audio.
          in: query
          schema:
            type: string
          example: 64k
        - name: quality
          description: Quality of final audio. Only 'worst' or 'best'.
          in: query
          schema:
            type: string
          example: worst
        - name: duration
          description: Duration of preview. Maximum 60 seconds.
          in: query
          schema:
            type: integer
          example: 45
      summary: Download video as cutted audio and providing link for you
      responses: null
components:
  schemas:
    SongFullObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 200
            name:
              type: string
              example: 1592415.ogg
            result:
              type: string
              example: https://imperialwool-funapi.hf.space/static/full/1592415.ogg
    SongPreviewObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 200
            name:
              type: string
              example: 1244874.mp3
            result:
              type: string
              example: https://b.ppy.sh/preview/1244874.mp3
    BeatmapObject:
      type: object
      properties:
        artist:
          type: string
          example: never gonna give you up remix
        beatmapId:
          type: integer
          example: 1542795
        creator:
          type: string
          example: CrisFloppa
        source:
          type: string
          example: ""
        tags:
          type: string
          example: never gonna gie you up rick roll
        title:
          type: string
          example: rick astley
    PredictedSentimentObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        predicted_sentiment:
          type: string
          example: Positive
    PredictedToxicityObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        toxicity:
          type: bool
          example: false
    FindBeatmapsObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 200
            result:
              type: array
              items:
                $ref: "#/components/schemas/BeatmapObject"
    JokeObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 200
            result:
              type: string
              example: |-
                .NET developers are picky when it comes to food.
                They only like chicken NuGet
    JokeSourceObject:
      type: object
      properties:
        lang1:
          type: array
          items:
            - source 1
            - source 2
            - source 3
            - source 4
            - source 5
        lang2:
          type: array
          items:
            - source 1
            - source 2
            - source 3
            - source 4
            - source 5
    SysinfoObject:
      type: object
      properties:
        API_VERSION:
          type: string
          example: $VERSION_VARIABLE$
        CPU_INFO:
          type: object
          properties:
            cpu_brand:
              type: string
              example: AMD EPYC 7R13 Processor
            cpu_count:
              type: object
              properties:
                all:
                  type: integer
                  example: 16
                exclude_virtual:
                  type: integer
                  example: 8
            cpu_freq:
              type: object
              properties:
                current:
                  type: number
                  format: float
                  example: 3522.9323125
                min:
                  type: number
                  format: float
                  example: 0
                max:
                  type: number
                  format: float
                  example: 3600
            cpu_load:
              type: number
              format: float
              example: 16.2
        MEM_INFO:
          type: object
          properties:
            mem_total:
              type: integer
              example: 126125
            mem_used:
              type: integer
              example: 87497
    ErrorObject:
      type: object
      properties:
        status:
          type: string
          example: error
        details:
          type: object
          properties:
            error_code:
              type: integer
              example: 1337
            error_details:
              type: string
              example: Some error
    YTSearchObject:
      type: object
      properties:
        status:
          type: string
          example: ok
        query:
          type: string
          example: never gonna give you up
        videoIds:
          type: object
          properties:
            "0":
              type: string
              example: dQw4w9WgXcQ
            "1":
              type: string
              example: GtL1huin9EE
            "2":
              type: string
              example: uXV-IaR_vNE
    YTFullObject:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 0
            name:
              type: string
              example: R8YprjS6ztg.ogg
            result:
              type: string
              example: https://imperialwool-funapi.hf.space/static/full/R8YprjS6ztg.ogg
    YTPreviewResult:
      type: object
      properties:
        status:
          type: string
          example: pass
        details:
          type: object
          properties:
            code:
              type: integer
              example: 0
            name:
              type: string
              example: R8YprjS6ztg.ogg
            result:
              type: string
              example: https://imperialwool-funapi.hf.space/static/previews/R8YprjS6ztg.ogg