Create Image from Template

Send a POST request to this endpoint to create a new image using a predefined template.

ℹ️

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

ℹ️

This endpoint consumes 1 credit per successful image generation.

Request


POST https://api.ojo.so/v1/image/template

Request Body

Parameter	Type	Description
templateId	string	The ID of the template to use
modify	object	(Optional) An object containing variables to modify in the template
viewportHeight	number	(Optional) Height of the viewport in pixels (default: 800)
viewportWidth	number	(Optional) Width of the viewport in pixels (default: 1280)
transparentBackground	boolean	(Optional) When set to true, generates the image with a transparent background. Defaults to false if not specified.

cURL


curl --request POST \
  --url https://api.ojo.so/v1/image/template \
  --header 'Authorization: Bearer <API Key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateId": "your-template-id",
    "modify": {
      "title": "Custom Title"
    },
    "viewportHeight": 1000,
    "viewportWidth": 1500
  }'

Python


import requests
 
url = "https://api.ojo.so/v1/image/template"
 
payload = {
"templateId": "your-template-id",
"modify": {
"title": "Custom Title"
},
"viewportHeight": 1000,
"viewportWidth": 1500
}
 
headers = {
"Authorization": "Bearer <API Key>",
"Content-Type": "application/json"
}
 
response = requests.post(url, json=payload, headers=headers)
 
print(response.text)

JavaScript


const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <API Key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    templateId: 'your-template-id',
    modify: {
      title: 'Custom Title'
    },
    viewportHeight: 1000,
    viewportWidth: 1500
  })
};
 
fetch('https://api.ojo.so/v1/image/template', 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/image/template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateId' => 'your-template-id',
'modify' => [
'title' => 'Custom Title'
],
'viewportHeight' => 1000,
'viewportWidth' => 1500
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <API Key>",
"Content-Type: application/json"
],
]);
 
$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"
  "strings"
  "net/http"
  "io/ioutil"
)
 
func main() {
  url := "https://api.ojo.so/v1/image/template"
  payload := strings.NewReader(`{
    "templateId": "your-template-id",
    "modify": {
      "title": "Custom Title"
    },
    "viewportHeight": 1000,
    "viewportWidth": 1500
  }`)
 
  req, _ := http.NewRequest("POST", url, payload)
 
  req.Header.Add("Authorization", "Bearer <API Key>")
  req.Header.Add("Content-Type", "application/json")
 
  res, _ := http.DefaultClient.Do(req)
 
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)
 
  fmt.Println(string(body))
}

Java


OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"templateId\": \"your-template-id\",\n  \"modify\": {\n    \"title\": \"Custom Title\"\n  },\n  \"viewportHeight\": 1000,\n  \"viewportWidth\": 1500\n}");
Request request = new Request.Builder()
  .url("https://api.ojo.so/v1/image/template")
  .method("POST", body)
  .addHeader("Authorization", "Bearer <API Key>")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

200

Everything went as planned and your image is generated.


{
  "id": "image-id",
  "imageUrl": "https://example.com/path/to/image.png",
  "createdAt": "2023-08-29T12:34:56Z"
}

401

Your API key might be invalid or expired.


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

402

Your credits are depleted. You need to purchase more credits to use the API.


{
  "error": true,
  "message": "Payment Required"
}

404

Requested templateId is invalid.


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

422

Request payload unprocessable. Update necessary fields and try again.


{
  "error": true,
  "message": "Provided inputs are not valid",
  "validationErrors": [
    {
      "path": "templateId",
      "message": "Required"
    }
  ]
}

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"
}