Get Template

Retrieve details of a specific image template by its ID.

ℹ️

You will need to authenticate to use this API. See authentication.

Request


GET https://api.ojo.so/v1/template/:templateId

Path Parameters

Parameter	Type	Description
templateId	string	The unique identifier of the template

cURL


curl --request GET \
  --url https://api.ojo.so/v1/template/<Replace with template ID> \
  --header 'Authorization: Bearer <API Key>'

Python


import requests
 
url = "https://api.ojo.so/v1/template/<Replace with template ID>"
 
headers = {
"Authorization": "Bearer <API Key>"
}
 
response = requests.request("GET", url, headers=headers)
 
print(response.text)

JavaScript


const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API Key>'
  }
};
 
fetch('https://api.ojo.so/v1/template/<Replace with template ID>', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

PHP


<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ojo.so/v1/template/<Replace with template 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 => [
"Authorization: Bearer <API Key>"
],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

Go


package main
 
import (
  "fmt"
  "net/http"
  "io/ioutil"
)
 
func main() {
  url := "https://api.ojo.so/v1/template/<Replace with template ID>"
 
  req, _ := http.NewRequest("GET", url, nil)
 
  req.Header.Add("Authorization", "Bearer <API Key>")
 
  res, _ := http.DefaultClient.Do(req)
 
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)
 
  fmt.Println(string(body))
}

Java


HttpResponse<String> response = Unirest.get("https://api.ojo.so/v1/template/<Replace with template ID>")
  .header("Authorization", "Bearer <API Key>")
  .asString();

Response

200

Successfully retrieved the template details.


{
  "id": "template-uuid-1",
  "name": "Template 1",
  "html": "...base64 encoded HTML...",
  "variables": {...},
  "previewUrl": "https://example.com/path/to/preview1.png",
  "createdAt": "2023-08-30T12:34:56Z",
  "updatedAt": "2023-08-30T12:34:56Z"
}

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized"
}

404

The specified template was not found.


{
  "error": true,
  "message": "Template not found"
}

429

You have hit your rate limit. You can view rate limit details here.


Too Many Requests

500

An unexpected error occurred. Try again later. If the issue persists, please reach out.


{
  "error": true,
  "message": "Internal server error"
}