> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weryai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Effect Template List

> Get a paginated list of effect templates with their configurations. Currently only IMAGE type templates are available via Open API.



## OpenAPI

````yaml /openapi-en.json get /v1/generation/effect-template/list
openapi: 3.0.3
info:
  title: WeryAI Generation API
  description: >
    WeryAI Open API provides AI-powered image and video generation capabilities.


    ## Authentication

    All API requests require Bearer token authentication:

    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    ## Task Status

    Generation tasks are processed asynchronously. After submission, you'll
    receive a `task_id` to query the task status and results.


    Task status descriptions:

    - `waiting` - Waiting for processing

    - `processing` - In progress

    - `succeed` - Completed successfully

    - `failed` - Failed


    ## Webhook Callback

    If you provide a `webhook_url`, a POST request containing the task result
    will be sent to that address when the task is completed.
  version: 1.0.0
  contact:
    name: WeryAI Support
    url: https://weryai.com
    email: support@weryai.com
servers:
  - url: https://api.weryai.com
    description: Production Server
security: []
tags:
  - name: Image Generation
    description: Image generation related APIs
  - name: Image Tools
    description: Image editing and processing tool APIs
  - name: Video Generation
    description: Video generation related APIs
  - name: Podcast Generation
    description: Podcast generation related APIs
  - name: Chat
    description: Chat related APIs
  - name: Music Generation
    description: Music generation related APIs
  - name: Effect Template
    description: Effect template related APIs
  - name: File Upload
    description: File upload related APIs
  - name: Tasks
    description: Task query related APIs
  - name: Account
    description: Account related APIs
  - name: Video Tools
    description: Video processing and editing tools APIs
  - name: Audio Tools
    description: >-
      Audio processing and recognition tools APIs


      ## Voice Reference


      The following system voices are available for use with the `voice_id`
      parameter:


      ### English Voices


      | ID | Voice Name | Gender | Preview |

      |---|---|---|---|

      | 85 | Captivating Female | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/3987dd96b7ca46d94dd242cecf32663f.mp3)
      |

      | 84 | Playful Girl | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/cfdefca3904e8db50b05c35b0bbd5e45.mp3)
      |

      | 83 | Lovely Girl | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/2bea3739397fe4fb36346bf65e831d42.mp3)
      |

      | 82 | Cheerful Chloe | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/361f42d41f382276d2d64ec0e4851863.mp3)
      |

      | 81 | Wise Lady | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/df04fdbd3e78d00623b38dec086cf304.mp3)
      |

      | 75 | Southern Dude | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/b565f04d06b7a5f92d33f4edf8fee417.mp3)
      |

      | 74 | Lucky Robot | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/c663ca5b792ad462be53a429262eb974.mp3)
      |

      | 73 | Angry Pirate | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/dcc98bc48ce5cbc2c346878a0330acaa.mp3)
      |

      | 72 | Friendly Giant | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/54ba0fb660d8a7efac178ca7456a08a9.mp3)
      |

      | 71 | Man With Deep Voice | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/9493f3c864b5eabd18992cad528b67e5.mp3)
      |


      ### Chinese Voices


      | ID | Voice Name | Gender | Preview |

      |---|---|---|---|

      | 80 | Arrogant Miss | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/a84538991f639fb8b181d28af21c84eb.mp3)
      |

      | 79 | Kind-hearted Antie | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/00d27936559b4b35886c9e1060092227.mp3)
      |

      | 78 | Gentle Senior | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/ba07358a0a5027e7e74f2377137600a8.mp3)
      |

      | 77 | Intellectual Girl | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/091ae63f445f196f82571f6925ab8c5e.mp3)
      |

      | 76 | News Anchor | FEMALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/2b84f899ad50a01f3d3671ee55bed9d7.mp3)
      |

      | 70 | Stubborn Friend | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/18736aee7085e96d76b8755bf2ca181b.mp3)
      |

      | 69 | Reliable Executive | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/49e33c6f237fb98450ef2c1e1a30ec09.mp3)
      |

      | 68 | Lyrical Voice | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/bda4d4eb6bb331ec2e151eb3e1316bf1.mp3)
      |

      | 67 | Refreshing Young Man | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/f11374b6b82b1193f6429c3729420b1f.mp3)
      |

      | 66 | Pure-hearted Boy | MALE | [▶
      Preview](https://static.weryai.com/growth/audio/audio/4af3a0b6c87a04ec3b5ed096f1b56572.mp3)
      |
  - name: Deep Research
    description: Deep Research related APIs
paths:
  /v1/generation/effect-template/list:
    get:
      tags:
        - Effect Template
      summary: Get Effect Template List
      description: >-
        Get a paginated list of effect templates with their configurations.
        Currently only IMAGE type templates are available via Open API.
      operationId: listEffectTemplates
      parameters:
        - name: type
          in: query
          required: false
          description: Template type, only IMAGE is available
          schema:
            type: string
          example: IMAGE
        - name: pageNum
          in: query
          required: false
          description: Page number, default 1
          schema:
            type: integer
            default: 1
            minimum: 1
          example: 1
        - name: pageSize
          in: query
          required: false
          description: Number of items per page, default 10
          schema:
            type: integer
            default: 10
            minimum: 1
          example: 10
      responses:
        '200':
          description: Query successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectTemplateListResponse'
              example:
                status: 0
                desc: success
                message: success
                data:
                  content:
                    - id: 1001
                      name: AI Portrait
                      type: IMAGE
                      cover_url: https://cdn.weryai.com/template/cover1.jpg
                      configs:
                        - id: 2001
                          name: Style A
                          cover_url: https://cdn.weryai.com/template/config_cover1.jpg
                          sample_urls:
                            - https://cdn.weryai.com/template/sample1.jpg
                          image_input: 1
                          aspect_ratio:
                            - '1:1'
                            - '16:9'
                          bgm: false
                          credit: 10
                          prompt_customizable: true
                          prompt_variables:
                            - key: style
                              index: 0
                  page: 1
                  page_size: 10
                  total_page: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - BearerAuth: []
components:
  schemas:
    EffectTemplateListResponse:
      type: object
      properties:
        status:
          type: integer
          description: Business status code (0 indicates success)
          example: 0
        desc:
          type: string
          description: Status description
          example: success
        message:
          type: string
          description: Multi-language message
          example: success
        data:
          type: object
          properties:
            content:
              type: array
              items:
                $ref: '#/components/schemas/OpenEffectTemplate'
              description: List of effect templates
            page:
              type: integer
              description: Current page number
              example: 1
            page_size:
              type: integer
              description: Number of items per page
              example: 10
            total_page:
              type: integer
              format: int64
              description: Total number of pages
              example: 1
            total:
              type: integer
              format: int64
              description: Total number of records
              example: 1
    OpenEffectTemplate:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Template ID
          example: 1001
        name:
          type: string
          description: Template name
          example: AI Portrait
        type:
          type: string
          description: 'Template type. Supported values: `IMAGE`, `VIDEO`.'
          example: IMAGE
        cover_url:
          type: string
          format: uri
          description: Template cover image URL
          example: https://cdn.weryai.com/template/cover1.jpg
        configs:
          type: array
          items:
            $ref: '#/components/schemas/OpenEffectTemplateConfig'
          description: List of template configurations
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: Business status code
          example: 1001
        desc:
          type: string
          description: Error description
          example: Parameter error
        message:
          type: string
          description: Error message
          example: Model does not exist
    OpenEffectTemplateConfig:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Configuration ID (use as template_config_id when submitting tasks)
          example: 2001
        name:
          type: string
          description: Configuration name
          example: Style A
        cover_url:
          type: string
          format: uri
          description: Configuration cover image URL
          example: https://cdn.weryai.com/template/config_cover1.jpg
        sample_urls:
          type: array
          items:
            type: string
            format: uri
          description: Sample output URLs for preview
          example:
            - https://cdn.weryai.com/template/sample1.jpg
        image_input:
          type: integer
          description: Number of images required to upload
          example: 1
        aspect_ratio:
          type: array
          items:
            type: string
          description: Supported aspect ratios
          example:
            - '1:1'
            - '16:9'
        bgm:
          type: boolean
          description: Whether background music is supported
          example: false
        credit:
          type: integer
          description: Credits cost per generation
          example: 10
        prompt_customizable:
          type: boolean
          description: Whether user-defined prompt input is supported
          example: true
        prompt_variables:
          type: array
          items:
            $ref: '#/components/schemas/PromptVariable'
          description: >-
            Prompt placeholder variables (present when prompt_customizable is
            true)
    PromptVariable:
      type: object
      properties:
        key:
          type: string
          description: >-
            Placeholder variable name, used as key in prompt_inputs when
            submitting tasks
          example: style
        description:
          type: string
          description: Variable description
          example: Style description
        index:
          type: integer
          description: Display order index
          example: 0
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 1002
            desc: Authentication failed
            message: Invalid API Key
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Authenticate using Bearer token. Get your API Key from the [WeryAI
        Console](https://weryai.com/api/keys).


        Example: `Authorization: Bearer sk-xxxxxxxxxxxxxxxx`

````