Get Template Video

Retrieve video information, status, and metadata by video ID

GET /v2/template_video/{video_id}

Get template video status and details

cURL

curl --request GET \
  --url https://api.jogg.ai/v2/template_video/{video_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.jogg.ai/v2/template_video/{video_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jogg.ai/v2/template_video/{video_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jogg.ai/v2/template_video/{video_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jogg.ai/v2/template_video/{video_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jogg.ai/v2/template_video/{video_id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/template_video/{video_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456789",
    "status": "completed",
    "created_at": 1640995200,
    "completed_at": 1640995500,
    "data": {
      "video_name": "My Template Video",
      "url": "https://example.com/video.mp4",
      "cover_url": "https://example.com/cover.jpg",
      "duration_seconds": 30.5,
      "deducted_credit": 10.5
    }
  }
}

Retrieve video information, status, and metadata by video ID.

Example Usage

curl --request GET \
  --url 'https://api.jogg.ai/v2/template_video/video_123456789' \
  --header 'x-api-key: YOUR_API_KEY'

Related Guides

Create Video from Template

Create videos from templates

Create Video from Template

Complete template video guide

Authorizations

x-api-key · string · header · required

API key for authentication. Obtain your key from the JoggAI dashboard.

Path Parameters

video_id · string · required

Video ID

Example:

"video_123456789"

Response

200 - application/json

Success

code · integer · 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

Example:

0

msg · string · required

Response message

Example:

"Success"

data · object

Show child attributes