Rendley docs

API reference

Templates

List templates

GEThttps://api.rendley.com/v1/templates

Without workspace_id: the published Rendley templates, paginated, with optional search and category filtering. With workspace_id (signed in): the user templates saved in that workspace, newest first; source_project_id is set while that project exists. There, query/category_id are ignored.

const res = await fetch("https://api.rendley.com/v1/templates", {
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/templates"
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates",
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/templates");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/templates", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}
require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/templates")
req = Net::HTTP::Get.new(uri)

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

Response 200

{
  "data": [
    {
      "created_at": "string",
      "created_by": "string",
      "fields": [
        {
          "group": "string",
          "key": "string",
          "label": "string",
          "length": 0,
          "linked": 0,
          "media_kind": "image",
          "path": "string",
          "type": "text",
          "value": {}
        }
      ],
      "fit_duration": 0,
      "height": 0,
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "is_premium": true,
      "name": "string",
      "preview_video_url": "string",
      "source_project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "template_json": "string",
      "thumbnail_url": "string",
      "updated_at": "string",
      "width": 0,
      "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
    }
  ]
}

Get a template

GEThttps://api.rendley.com/v1/templates/{id}

A Rendley template with its document, or (signed in) a user template with the fields it exposes and their current values. Rendley templates have no fields. Pass values to POST /projects as fields, keyed by each field's key. A media field takes a public https URL of a file of its media_kind.

const res = await fetch("https://api.rendley.com/v1/templates/ID", {
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/templates/ID"
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/ID",
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/templates/ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/templates/ID", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}
require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/templates/ID")
req = Net::HTTP::Get.new(uri)

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

Response 200

{
  "data": {
    "created_at": "string",
    "created_by": "string",
    "fields": [
      {
        "group": "string",
        "key": "string",
        "label": "string",
        "length": 0,
        "linked": 0,
        "media_kind": "image",
        "path": "string",
        "type": "text",
        "value": {}
      }
    ],
    "fit_duration": 0,
    "height": 0,
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "is_premium": true,
    "name": "string",
    "preview_video_url": "string",
    "source_project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "template_json": "string",
    "thumbnail_url": "string",
    "updated_at": "string",
    "width": 0,
    "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  }
}

Delete a user template

DELETEhttps://api.rendley.com/v1/templates/{id}

Delete the user template and its files. Only its author or the workspace owner can. Its source project and projects started from it are not affected. Rendley templates can't be deleted here.

Don't have one? Create an API key

const res = await fetch("https://api.rendley.com/v1/templates/ID", {
  method: "DELETE",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
curl -X DELETE "https://api.rendley.com/v1/templates/ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
import requests

res = requests.delete(
    "https://api.rendley.com/v1/templates/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/templates/ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.rendley.com/v1/templates/ID", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}
require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/templates/ID")
req = Net::HTTP::Delete.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

List template categories

Retrieve all available template categories.

GEThttps://api.rendley.com/v1/templates/categories
const res = await fetch("https://api.rendley.com/v1/templates/categories", {
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/templates/categories"
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/categories",
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/templates/categories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/templates/categories", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}
require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/templates/categories")
req = Net::HTTP::Get.new(uri)

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

Response 200

{
  "data": [
    {
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "name": "string"
    }
  ]
}

Get templates overview

Retrieve an overview of Rendley templates grouped by category.

GEThttps://api.rendley.com/v1/templates/overview
const res = await fetch("https://api.rendley.com/v1/templates/overview", {
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/templates/overview"
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/overview",
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/templates/overview");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/templates/overview", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}
require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/templates/overview")
req = Net::HTTP::Get.new(uri)

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

Response 200

{
  "data": [
    {
      "category_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "category_name": "string",
      "templates": [
        {
          "created_at": "string",
          "created_by": "string",
          "fields": [
            {}
          ],
          "fit_duration": 0,
          "height": 0,
          "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "is_premium": true,
          "name": "string",
          "preview_video_url": "string",
          "source_project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "template_json": "string",
          "thumbnail_url": "string",
          "updated_at": "string",
          "width": 0,
          "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
        }
      ]
    }
  ]
}