@j-o-r/hello-dave 0.0.10 → 0.1.1

package/lib/API/minimax/music.lyrics.generation.md

@@ -0,0 +1,205 @@
+> ## Documentation Index
+> Fetch the complete documentation index at: https://platform.minimax.io/docs/llms.txt
+> Use this file to discover all available pages before exploring further.
+
+# Lyrics Generation
+
+> Use this API to generate lyrics, supporting full song creation and lyrics editing/continuation.
+
+
+
+## OpenAPI
+
+````yaml POST /v1/lyrics_generation
+openapi: 3.1.0
+info:
+  title: MiniMax Lyrics Generation API
+  description: >-
+    MiniMax Lyrics Generation API with support for full song creation and lyrics
+    editing/continuation
+  license:
+    name: MIT
+  version: 1.0.0
+servers:
+  - url: https://api.minimax.io
+security:
+  - bearerAuth: []
+paths:
+  /v1/lyrics_generation:
+    post:
+      tags:
+        - Music
+      summary: Lyrics Generation
+      operationId: generateLyrics
+      parameters:
+        - name: Content-Type
+          in: header
+          required: true
+          description: >-
+            The media type of the request body. Must be set to
+            `application/json` to ensure the data is sent in JSON format.
+          schema:
+            type: string
+            enum:
+              - application/json
+            default: application/json
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/GenerateLyricsReq'
+        required: true
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenerateLyricsResp'
+components:
+  schemas:
+    GenerateLyricsReq:
+      type: object
+      required:
+        - mode
+      properties:
+        mode:
+          type: string
+          description: >-
+            Generation mode.<br>`write_full_song`: Write a complete
+            song<br>`edit`: Edit/continue existing lyrics
+          enum:
+            - write_full_song
+            - edit
+        prompt:
+          type: string
+          description: >-
+            Prompt/instruction describing the song theme, style, or editing
+            direction. If empty, a random song will be generated.
+          maxLength: 2000
+        lyrics:
+          type: string
+          description: >-
+            Existing lyrics content. Only effective in `edit` mode. Can be used
+            for continuation or modification of existing lyrics.
+          maxLength: 3500
+        title:
+          type: string
+          description: Song title. If provided, the output will keep this title unchanged.
+      example:
+        mode: write_full_song
+        prompt: A cheerful love song about a summer day at the beach
+    GenerateLyricsResp:
+      type: object
+      properties:
+        song_title:
+          type: string
+          description: >-
+            Generated song title. If `title` was provided in the request, it
+            will be preserved.
+        style_tags:
+          type: string
+          description: >-
+            Style tags, comma-separated. For example: `Pop, Upbeat, Female
+            Vocals`
+        lyrics:
+          type: string
+          description: >-
+            Generated lyrics with structure tags. Can be directly used in the
+            `lyrics` parameter of the [Music Generation
+            API](/api-reference/music-generation) to generate
+            songs.<br>Supported structure tags (14 types): `[Intro]`, `[Verse]`,
+            `[Pre-Chorus]`, `[Chorus]`, `[Hook]`, `[Drop]`, `[Bridge]`,
+            `[Solo]`, `[Build-up]`, `[Instrumental]`, `[Breakdown]`, `[Break]`,
+            `[Interlude]`, `[Outro]`
+        base_resp:
+          $ref: '#/components/schemas/BaseResp'
+      example:
+        song_title: Summer Breeze Promise
+        style_tags: Pop, Summer Vibe, Romance, Lighthearted, Beach Pop
+        lyrics: |-
+          [Intro]
+          (Ooh-ooh-ooh)
+          (Yeah)
+          Sunlight dancing on the waves
+
+          [Verse 1]
+          Sea breeze gently through your hair
+          Smiling face, like a summer dream
+          Waves are crashing at our feet
+          Leaving footprints, you and me
+          Laughter echoes on the sand
+          Every moment, a sweet melody
+          I see the sparkle in your eyes
+          Like the stars in the deep blue sea
+
+          [Pre-Chorus]
+          You say this feeling is so wonderful
+          (So wonderful)
+          Want to stay in this moment forever
+          (Right here, right now)
+          Heartbeat racing like the ocean waves
+
+          [Chorus]
+          Oh, summer by the sea, our promise true
+          In the sunlight, your silhouette so beautiful
+          The breeze blows away our worries, leaving only sweet
+          This moment, I just want to be with you, eternally
+          (Forever with you)
+
+          [Verse 2]
+          ...
+        base_resp:
+          status_code: 0
+          status_msg: success
+    BaseResp:
+      type: object
+      description: Status code and details
+      properties:
+        status_code:
+          type: integer
+          description: >-
+            Status codes and their meanings:
+
+
+            `0`: Success
+
+
+            `1002`: Rate limit triggered, retry later
+
+
+            `1004`: Authentication failed, check API key
+
+
+            `1008`: Insufficient balance
+
+
+            `1026`: Input contains sensitive content
+
+
+            `2013`: Invalid parameters, check input
+
+
+            `2049`: Invalid API key
+
+
+            For more information, please refer to the [Error Code
+            Reference](/api-reference/errorcode).
+        status_msg:
+          type: string
+          description: Detailed error message
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: >-
+        `HTTP: Bearer Auth`
+
+        - Security Scheme Type: http
+
+        - HTTP Authorization Scheme: `Bearer API_key`, can be found in [Account
+        Management>API
+        Keys](https://platform.minimax.io/user-center/basic-information/interface-key).
+
+````

package/lib/API/minimax/video.download.md

@@ -0,0 +1,133 @@
+
+> ## Documentation Index
+> Fetch the complete documentation index at: https://platform.minimax.io/docs/llms.txt
+> Use this file to discover all available pages before exploring further.
+
+# Video Download
+
+> Use this API to download generated videos.
+
+
+
+## OpenAPI
+
+````yaml /api-reference/video/generation/api/openapi.json GET /v1/files/retrieve
+openapi: 3.1.0
+info:
+  title: MiniMax API
+  description: MiniMax video generation and file management API
+  license:
+    name: MIT
+  version: 1.0.0
+servers:
+  - url: https://api.minimax.io
+security:
+  - bearerAuth: []
+paths:
+  /v1/files/retrieve:
+    get:
+      tags:
+        - Files
+      summary: Retrieve File
+      operationId: retrieveFile
+      parameters:
+        - name: file_id
+          in: query
+          required: true
+          description: >-
+            The unique identifier for the file.
+
+            Supports `file_id` obtained from video generation and asynchronous
+            speech synthesis tasks.
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RetrieveFileResp'
+components:
+  schemas:
+    RetrieveFileResp:
+      type: object
+      properties:
+        file:
+          $ref: '#/components/schemas/FileObject'
+        base_resp:
+          $ref: '#/components/schemas/RetrieveFileBaseResp'
+      example:
+        file:
+          file_id: ${file_id}
+          bytes: 0
+          created_at: 1700469398
+          filename: output_aigc.mp4
+          purpose: video_generation
+          download_url: www.downloadurl.com
+        base_resp:
+          status_code: 0
+          status_msg: success
+    FileObject:
+      type: object
+      properties:
+        file_id:
+          type: integer
+          format: int64
+          description: The unique identifier for the file.
+        bytes:
+          type: integer
+          format: int64
+          description: The size of the file in bytes.
+        created_at:
+          type: integer
+          format: int64
+          description: The Unix timestamp (in seconds) when the file was created.
+        filename:
+          type: string
+          description: The name of the file.
+        purpose:
+          type: string
+          description: The purpose of the file.
+        download_url:
+          type: string
+          format: url
+          description: The URL address for downloading the file, valid for 1 hour.
+    RetrieveFileBaseResp:
+      type: object
+      properties:
+        status_code:
+          type: integer
+          description: |-
+            The status codes are as follows:
+            - 1000, Unknown error;
+            - 1001, Timeout;
+            - 1002, RPM limit triggered;
+            - 1004, Authentication failed;
+            - 1008, Insufficient balance;
+            - 1013, Internal service error;
+            - 1026, Input content error;
+            - 1027, Output content error;
+            - 1039, TPM limit triggered;
+            - 2013, Abnormal input format.
+
+             For more information, please refer to the [Error Code Reference](/api-reference/errorcode).
+        status_msg:
+          type: string
+          description: Status details.
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: >-
+        `HTTP: Bearer Auth`
+
+        - Security Scheme Type: http
+
+        - HTTP Authorization Scheme: `Bearer API_key`, can be found in [Account
+        Management>API
+        Keys](https://platform.minimax.io/user-center/basic-information/interface-key).
+
+````

package/lib/API/minimax/video.first.last.image.md

@@ -0,0 +1,186 @@
+> ## Documentation Index
+> Fetch the complete documentation index at: https://platform.minimax.io/docs/llms.txt
+> Use this file to discover all available pages before exploring further.
+
+# Create First & Last Frame Video Generation Task
+
+> Use this API to create a video generation task from start and end frame images, with optional text input.
+
+
+
+## OpenAPI
+
+````yaml /api-reference/video/generation/api/start-end-to-video.json POST /v1/video_generation
+openapi: 3.1.0
+info:
+  title: MiniMax API
+  description: MiniMax video generation and file management API
+  license:
+    name: MIT
+  version: 1.0.0
+servers:
+  - url: https://api.minimax.io
+security:
+  - bearerAuth: []
+paths:
+  /v1/video_generation:
+    post:
+      tags:
+        - Video
+      summary: Video Generation
+      operationId: videoGeneration
+      parameters:
+        - name: Content-Type
+          in: header
+          required: true
+          description: >-
+            The media type of the request body. Must be set to
+            `application/json` to ensure the data is sent in JSON format.
+          schema:
+            type: string
+            enum:
+              - application/json
+            default: application/json
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/VideoGenerationReq'
+        required: true
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoGenerationResp'
+components:
+  schemas:
+    VideoGenerationReq:
+      type: object
+      required:
+        - model
+        - last_frame_image
+      properties:
+        model:
+          type: string
+          description: >-
+            Model name. Supported values: `MiniMax-Hailuo-02`.
+
+
+            Note: First & last frame generation does not support 512P
+            resolution.
+          enum:
+            - MiniMax-Hailuo-02
+        prompt:
+          type: string
+          description: "Text description of the video, up to 2000 characters.\nFor `MiniMax-Hailuo-02`, you can use `[commands]` syntax for camera movement control.\nCamera movement commands can be embedded in `prompt` using the `[command]` format for precise control.  \n- **Supported 15 camera commands**:\n\t- Truck: `[Truck left]`, `[Truck right]`\n\t- Pan: `[Pan left]`, `[Pan right]`\n\t- Push: `[Push in]`, `[Pull out]`\n\t- Pedestal: `[Pedestal up]`, `[Pedestal down]`\n\t- Tilt: `[Tilt up]`, `[Tilt down]`\n\t- Zoom: `[Zoom in]`, `[Zoom out]`\n\t- Shake: `[Shake]`\n\t- Follow: `[Tracking shot]`\n\t- Static: `[Static shot]`\n\r\n- **Usage rules**: \n  - *Combined movements*: Multiple commands inside one `[]` take effect simultaneously (e.g., `[Pan left,Pedestal up]`). Recommended max: 3. \n  - *Sequential movements*: Commands appear in order, e.g., `\"...[Push in], then...[Push out]\"`. \n  - *Natural language*: Free-form descriptions also work, but explicit commands yield more accurate results. "
+        first_frame_image:
+          type: string
+          description: "Image to be used as the **first frame** of the video. Supports public URLs or Base64-encoded [Data URLs](https://developer.mozilla.org/en-US/docs/Web/URI/Reference/Schemes/data) (`data:image/jpeg;base64,...`).\n\n- Image requirements:\n\t- Formats: JPG, JPEG, PNG, WebP\n\t- Size: < 20MB\n\t- Dimensions: Short side > 300px; Aspect ratio between 2:5 and 5:2\n\n⚠️ Video resolution follows the first frame image"
+        last_frame_image:
+          type: string
+          description: "Image to be used as the **last frame** of the video. Supports public URLs or Base64-encoded [Data URLs](https://developer.mozilla.org/en-US/docs/Web/URI/Reference/Schemes/data) (`data:image/jpeg;base64,...`).\n\n- Image requirements:\n\t- Formats: JPG, JPEG, PNG, WebP\n\t- Size: < 20MB\n\t- Dimensions: Short side > 300px; Aspect ratio between 2:5 and 5:2\n\n⚠️ Video resolution is determined by the first frame. If first and last frames differ in size, the last frame will be cropped to match the first"
+        prompt_optimizer:
+          type: boolean
+          description: >-
+            Whether to automatically optimize the `prompt`. Defaults to `true`.
+            Set to `false` for more precise control.
+        duration:
+          type: integer
+          description: >-
+            Video duration (in seconds). Default: `6`. Available values for
+            first & last frame generation depend on resolution:
+
+
+            | Model | 768P | 1080P |
+
+            | :--- | :--- | :--- |
+
+            | MiniMax-Hailuo-02 | `6` or `10` | `6` |
+        resolution:
+          type: string
+          description: >-
+            Video resolution. First & last frame generation supports 768P and
+            1080P:
+
+
+            | Model | 6s | 10s |
+
+            | :--- | :--- | :--- |
+
+            | MiniMax-Hailuo-02 | `768P` (default), `1080P` | `768P` |
+          enum:
+            - 768P
+            - 1080P
+        callback_url:
+          type: string
+          description: "A callback URL to receive asynchronous task status updates.\n1. **Validation**: Once configured, MiniMax sends a `POST` request with a `challenge` field. Your server must echo this value within 3s to validate.\n2. **Updates**: After validation, MiniMax pushes status updates when the task changes. Response structure matches the [*Query Video Generation Task* API](/api-reference/video-generation-query).  \n\n**Callback `status` values**:\n- `\"processing\"` – Task in progress\n- `\"success\"` – Task completed successfully\n- `\"failed\"` – Task failed\n\n```python\nfrom fastapi import FastAPI, HTTPException, Request\r\nimport json\r\n\r\napp = FastAPI()\r\n\r\n@app.post(\"/get_callback\")\r\nasync def get_callback(request: Request):\r\n    try:\r\n        json_data = await request.json()\r\n        challenge = json_data.get(\"challenge\")\r\n        if challenge is not None:\r\n            # Validation request, echo back challenge\r\n            return {\"challenge\": challenge}\r\n        else:\r\n            # Status update request, handle accordingly\r\n            # {\r\n            #     \"task_id\": \"115334141465231360\",\r\n            #     \"status\": \"success\",\r\n            #     \"file_id\": \"205258526306433\",\r\n            #     \"base_resp\": {\r\n            #         \"status_code\": 0,\r\n            #         \"status_msg\": \"success\"\r\n            #     }\r\n            # }\r\n            return {\"status\": \"success\"}\r\n    except Exception as e:\r\n        raise HTTPException(status_code=500, detail=str(e))\r\n\r\nif __name__ == \"__main__\":\r\n    import uvicorn\r\n    uvicorn.run(\r\n        app,  # Required\r\n        host=\"0.0.0.0\",  # Required\r\n        port=8000,  # Required, port can be customized\r\n        # ssl_keyfile=\"yourname.yourDomainName.com.key\",  # Optional, enable if using SSL\r\n        # ssl_certfile=\"yourname.yourDomainName.com.key\",  # Optional, enable if using SSL\r\n    )\n```"
+      example:
+        prompt: A little girl grow up.
+        first_frame_image: >-
+          https://filecdn.minimax.chat/public/fe9d04da-f60e-444d-a2e0-18ae743add33.jpeg
+        last_frame_image: >-
+          https://filecdn.minimax.chat/public/97b7cd08-764e-4b8b-a7bf-87a0bd898575.jpeg
+        model: MiniMax-Hailuo-02
+        duration: 6
+        resolution: 1080P
+    VideoGenerationResp:
+      type: object
+      properties:
+        task_id:
+          type: string
+          description: The video generation task ID, used for querying status.
+        base_resp:
+          $ref: '#/components/schemas/BaseResp'
+      example:
+        task_id: '106916112212032'
+        base_resp:
+          status_code: 0
+          status_msg: success
+    BaseResp:
+      type: object
+      properties:
+        status_code:
+          type: integer
+          description: >-
+            The status codes and their meanings are as follows:
+
+            - `0`, Request successful
+
+            - `1002`, Rate limit triggered, please try again later
+
+            - `1004`, Account authentication failed, please check if the API Key
+            is correct
+
+            - `1008`, Insufficient account balance
+
+            - `1026`, Sensitive content detected in prompt
+
+            - `2013`, Invalid input parameters, please check if the parameters
+            are filled in as required
+
+            - `2049`, Invalid API key
+
+
+            For more information, please refer to the [Error Code
+            Reference](/api-reference/errorcode).  
+        status_msg:
+          type: string
+          description: Status details.
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: >-
+        `HTTP: Bearer Auth`
+
+        - Security Scheme Type: http
+
+        - HTTP Authorization Scheme: `Bearer API_key`, can be found in [Account
+        Management>API
+        Keys](https://platform.minimax.io/user-center/basic-information/interface-key).
+
+````