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 <your API key>'

Python


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

JavaScript


const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your 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 <your 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 <your 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 <your API key>")
  .asString();

Response

200

Successfully retrieved the template details.


{
  "id": "template-uuid-1",
  "name": "Template 1",
  "description": "Monthly invoice",
  "html": "<h1>{{issuer.name}}</h1>{{#each items}}<p>{{title}}</p>{{/each}}<p>{{recipient_name}}</p>",
  "variables": {
    "issuer": { "name": "Acme Inc." },
    "items": [{ "title": "Consulting" }],
    "recipient_name": "Jane Sample"
  },
  "inputs": ["issuer.name", "items[].title", "recipient_name"],
  "createdAt": "2023-08-30T12:34:56Z",
  "updatedAt": "2023-08-30T12:34:56Z"
}

variables are the saved values. inputs are the data paths the HTML reads, sorted: items[].title is the title of each item of items. Send these in modify when you render.

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "detail": "Unauthorized"
}

404

The specified template was not found.


{
  "error": true,
  "message": "Template not found",
  "status": 404,
  "title": "Not Found",
  "detail": "Template not found"
}

429

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


{
  "error": true,
  "message": "Template rate limit reached: 30 template requests per minute",
  "logs": ["Try again in 2 minutes."],
  "code": "rate_limited.template",
  "retryAfter": 120,
  "status": 429,
  "title": "Too Many Requests",
  "detail": "Template rate limit reached: 30 template requests per minute"
}

500

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


{
  "error": true,
  "message": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "detail": "Internal Server Error"
}