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

# Get Templates

> Retrieve a list of user's custom templates with optional filtering by aspect ratio.


Retrieve the list of available video templates.

## Example Usage

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/templates/custom' \
  --header 'x-api-key: YOUR_API_KEY'
```


## OpenAPI

````yaml GET /v2/templates/custom
openapi: 3.0.1
info:
  title: JoggAI OpenAPI v2
  description: >
    JoggAI OpenAPI v2 provides a comprehensive suite of endpoints for creating
    and managing AI-powered video content.


    ## Authentication

    All API requests require authentication using an API key provided in the
    `x-api-key` header.


    ## Base URL

    Production: https://api.jogg.ai/v2


    ## Rate Limiting

    API calls are subject to rate limiting based on your subscription plan.


    ## Error Handling

    All endpoints return standard HTTP status codes along with detailed error
    messages in the response body.
  version: 2.0.0
  license:
    name: MIT
servers:
  - url: https://api.jogg.ai
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Video
    description: Video creation and management operations
  - name: Avatar
    description: Avatar management and creation operations
  - name: Voice
    description: Voice and timbre management operations
  - name: Asset
    description: Asset management including music, scripts, and uploads
  - name: Template
    description: Template management operations
  - name: Product
    description: Product management operations
  - name: User
    description: User account operations
  - name: Webhook
    description: Webhook endpoint management for event notifications
paths:
  /v2/templates/custom:
    get:
      tags:
        - Template
      summary: List user's custom templates
      description: >
        Retrieve a list of user's custom templates with optional filtering by
        aspect ratio.
      parameters:
        - name: aspect_ratio
          in: query
          description: Filter by aspect ratio
          schema:
            type: string
            enum:
              - portrait
              - landscape
              - square
            example: portrait
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          templates:
                            type: array
                            items:
                              $ref: '#/components/schemas/TemplateInfo'
components:
  schemas:
    BaseResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: |
            Business status code:
            * 0 - Success
            * 10104 - Record not found
            * 10105 - Invalid API key
            * 18020 - Insufficient credit
            * 18025 - No permission to call APIs
            * 40000 - Parameter error
            * 50000 - System error
          example: 0
        msg:
          type: string
          description: Response message
          example: Success
    TemplateInfo:
      type: object
      properties:
        id:
          type: integer
          description: Template ID
        name:
          type: string
          description: Template name
        cover_url:
          type: string
          description: Template preview image
        preview_url:
          type: string
          description: Template preview video
        aspect_ratio:
          type: integer
          description: |
            Aspect ratio:
            * 0 - Portrait [9:16]
            * 1 - Landscape [16:9]
            * 2 - Square [1:1]
          enum:
            - 0
            - 1
            - 2
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain your key from the JoggAI dashboard.

````