JOjogg
Template

List index templates

Changed on

Retrieve a list of index templates with optional filtering by aspect ratio.

get/v2/templates

Request

  • Base URL
    https://api.jogg.ai
  • URL
    https://api.jogg.ai/v2/templates
  • Auth
    API key in header x-api-key

Query parameters

aspect_ratio'portrait' | 'landscape' | 'square'
Example:portrait

Screen aspect ratio filter:

  • portrait - Portrait [9:16]
  • landscape - Landscape [16:9]
  • square - Square [1:1]

Response

Success

codeinteger required

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
msgstring required

Response message

Example response

{
  "msg": "Success",
  "data": {
    "templates": [
      {
        "id": 123,
        "name": "Product Showcase",
        "cover_url": "https://res.jogg.ai/template-cover.jpg",
        "preview_url": "https://res.jogg.ai/template-preview.mp4",
        "aspect_ratio": 1
      }
    ]
  }
}

Changes