Templates

Get a template

Changed on

Returns one template including its TSX source in document.content. Approved templates are visible to everyone; others only to their author (everyone else gets 404).

get/templates/{id}

Request

  • Base URL: https://api.varg.ai/v2
  • URL: https://api.varg.ai/v2/templates/{id}
  • Auth: HTTP bearer

Response

The template

idstring uuid
documentIdstring uuid

The template's own (frozen) copy of the source document

sourceDocumentIdstring nullable

The document the author published it from

userIdstring

Author user id

descriptionstring
tagsstring[] nullable
statusstring

Moderation status. Only approved templates are public.

useCountinteger
favoriteCountinteger
isFavoritedboolean

Whether the calling user has favorited it

thumbnailObjectPositionstring
videoObjectPositionstring
isServiceTemplateboolean
previewUrlstring nullable

Short autoplay clip; null until the preview is ready

createdAtstring date-time
thumbnailUrlstring nullable
outputMediaUrlstring nullable
outputMediaTypestring nullable
durationMsinteger nullable

Output video duration in milliseconds

Example response

{
  "status": "approved",
  "thumbnailObjectPosition": "center center",
  "videoObjectPosition": "center center",
  "document": {
    "kind": "media",
    "visibility": "private"
  }
}

Changes