---
title: "Projects | Rendley API Docs"
description: "Create, read, update and delete projects. Start one from a template with new field values, then export it. A project holds the timeline the agent edits and the export renders, and can be duplicated or rolled back."
url: https://docs.rendley.com/api/projects/
---

# Projects

Create, read, update and delete projects. Start one from a template with new field values, then export it. A project holds the timeline the agent edits and the export renders, and can be duplicated or rolled back.

## List projects

List all projects in a workspace.

GET`https://api.rendley.com/v1/projects`

`workspace_id`optionalstring

`page`optionalinteger

`limit`optionalinteger

`sort`optionalstring

```
const res = await fetch("https://api.rendley.com/v1/projects", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl "https://api.rendley.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.get(
    "https://api.rendley.com/v1/projects",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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("GET", "https://api.rendley.com/v1/projects", 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/projects")
req = Net::HTTP::Get.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"]
```

Response 200

```
{
  "data": [
    {
      "agent_child_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "agent_job_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "agent_prompt": "string",
      "agent_skill": "string",
      "can_edit": true,
      "created_at": "string",
      "created_by": "string",
      "deleted_at": "string",
      "fit_duration": 0,
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "last_viewed_at": "string",
      "name": "string",
      "organization_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "project_json": "string",
      "template": {
        "fields": [
          {
            "alias": {},
            "clip_id": {},
            "group": {},
            "key": {},
            "label": {},
            "path": {},
            "property_id": {},
            "step": {}
          }
        ],
        "version": 0
      },
      "template_mode": true,
      "thumbnail_url": "string",
      "updated_at": "string",
      "version": 0,
      "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
    }
  ]
}
```

## Create a project

POST`https://api.rendley.com/v1/projects`

Create a new project, optionally from a template. workspace_id may be omitted when the account has exactly one workspace. template_id takes a Rendley template or a user template. `fields` sets a user template's fields by key or path (see GET /templates/{id}); a media field takes a public https URL, which is imported into the project.

", "agent_skill": "", "fields": { "prompt": "..." } }">

Body

`agent_prompt`optionalstring

AgentPrompt, when set, is stored on the project and prefilled into the assistant when the editor opens (MCP draft handoff).

`agent_skill`optionalstring

AgentSkill, when set with AgentPrompt, pre-selects that workflow skill in the assistant's picker so the handoff prompt runs pinned to it.

`fields`optionaljson

Values for the template's fields, by key or path. Requires template_id.

`name`optionalstring

Max matches the projects.name column (VARCHAR(255)). Defaults to the template's name when template_id is set.

`template_id`optionalstring

`workspace_id`optionalstring

Optional when the account has exactly one workspace: the project is created there. Required once a second workspace exists.

```
const res = await fetch("https://api.rendley.com/v1/projects", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "agent_prompt": "<agent_prompt>",
    "agent_skill": "<agent_skill>",
    "fields": {
      "prompt": "..."
    }
  }),
});
const { data } = await res.json();
```

```
curl -X POST "https://api.rendley.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_prompt": "<agent_prompt>",
    "agent_skill": "<agent_skill>",
    "fields": {
      "prompt": "..."
    }
  }'
```

```
import requests

res = requests.post(
    "https://api.rendley.com/v1/projects",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "agent_prompt": "<agent_prompt>",
        "agent_skill": "<agent_skill>",
        "fields": {
            "prompt": "..."
        }
    },
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["agent_prompt" => "<agent_prompt>", "agent_skill" => "<agent_skill>", "fields" => ["prompt" => "..."]]));

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

```
package main

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

func main() {
	body := bytes.NewBufferString(`{
  "agent_prompt": "<agent_prompt>",
  "agent_skill": "<agent_skill>",
  "fields": {
    "prompt": "..."
  }
}`)
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/projects", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	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/projects")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { agent_prompt: "<agent_prompt>", agent_skill: "<agent_skill>", fields: { prompt: "..." } }.to_json

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

Response 200

```
{
  "data": {
    "agent_child_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_job_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_prompt": "string",
    "agent_skill": "string",
    "can_edit": true,
    "created_at": "string",
    "created_by": "string",
    "deleted_at": "string",
    "fit_duration": 0,
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "last_viewed_at": "string",
    "name": "string",
    "organization_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "project_json": "string",
    "template": {
      "fields": [
        {
          "alias": "string",
          "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "group": "string",
          "key": "string",
          "label": "string",
          "path": "string",
          "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "step": "string"
        }
      ],
      "version": 0
    },
    "template_mode": true,
    "thumbnail_url": "string",
    "updated_at": "string",
    "version": 0,
    "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  }
}
```

## Get a project

Retrieve a single project by its ID.

GET`https://api.rendley.com/v1/projects/{id}`

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl "https://api.rendley.com/v1/projects/ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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("GET", "https://api.rendley.com/v1/projects/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/projects/ID")
req = Net::HTTP::Get.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"]
```

Response 200

```
{
  "data": {
    "agent_child_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_job_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_prompt": "string",
    "agent_skill": "string",
    "can_edit": true,
    "created_at": "string",
    "created_by": "string",
    "deleted_at": "string",
    "fit_duration": 0,
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "last_viewed_at": "string",
    "name": "string",
    "organization_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "project_json": "string",
    "template": {
      "fields": [
        {
          "alias": "string",
          "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "group": "string",
          "key": "string",
          "label": "string",
          "path": "string",
          "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "step": "string"
        }
      ],
      "version": 0
    },
    "template_mode": true,
    "thumbnail_url": "string",
    "updated_at": "string",
    "version": 0,
    "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  }
}
```

## Update a project

PATCH`https://api.rendley.com/v1/projects/{id}`

Update a project's mutable fields. Send only the fields you want to change. Public API keys may update metadata but cannot persist project_json until SDK schema validation is available; browser sessions retain the editor save behavior.

", "agent_skill": "" }">

`id`requiredstring

Body

`adopt_file_hashes`optionalstring[]

AdoptFileHashes lists role=pending uploads to retag role=library in the same request, AFTER the project JSON is saved: the atomic "save project + adopt pending uploads" step of the library injection flow. Adoption is skipped when the save itself fails.

`agent_prompt`optionalstring

AgentPrompt updates the stored handoff prompt out of band from the version-guarded document save: "" clears it (on send), non-empty sets it, nil leaves it untouched.

`agent_skill`optionalstring

AgentSkill is the handoff prompt's pinned workflow skill, with the same set/clear/untouched semantics as AgentPrompt.

`fit_duration`optionalnumber

`name`optionalstring

projects.name is VARCHAR(255).

`project_json`optionalstring

`template`optionalobject

Template replaces the promoted fields, outside the version guard.

`fields`optionalobject[]

`version`optionalinteger

`template_mode`optionalboolean

TemplateMode turns the fields form on or off.

false

`version`optionalinteger

```
const res = await fetch("https://api.rendley.com/v1/projects/ID", {
  method: "PATCH",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "adopt_file_hashes": [
      "string"
    ],
    "agent_prompt": "<agent_prompt>",
    "agent_skill": "<agent_skill>"
  }),
});
const { data } = await res.json();
```

```
curl -X PATCH "https://api.rendley.com/v1/projects/ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "adopt_file_hashes": [
      "string"
    ],
    "agent_prompt": "<agent_prompt>",
    "agent_skill": "<agent_skill>"
  }'
```

```
import requests

res = requests.patch(
    "https://api.rendley.com/v1/projects/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "adopt_file_hashes": [
            "string"
        ],
        "agent_prompt": "<agent_prompt>",
        "agent_skill": "<agent_skill>"
    },
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["adopt_file_hashes" => ["string"], "agent_prompt" => "<agent_prompt>", "agent_skill" => "<agent_skill>"]));

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

```
package main

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

func main() {
	body := bytes.NewBufferString(`{
  "adopt_file_hashes": [
    "string"
  ],
  "agent_prompt": "<agent_prompt>",
  "agent_skill": "<agent_skill>"
}`)
	req, _ := http.NewRequest("PATCH", "https://api.rendley.com/v1/projects/ID", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	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/projects/ID")
req = Net::HTTP::Patch.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { adopt_file_hashes: ["string"], agent_prompt: "<agent_prompt>", agent_skill: "<agent_skill>" }.to_json

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

## Delete a project

Delete a project by its ID.

DELETE`https://api.rendley.com/v1/projects/{id}`

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID", {
  method: "DELETE",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl -X DELETE "https://api.rendley.com/v1/projects/ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.delete(
    "https://api.rendley.com/v1/projects/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/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/projects/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/projects/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"]
```

## Agent working on a project

The server-side agent job working on the project, if any. While one runs the project is read-only for the editor, and the job's saves are the only ones.

GET`https://api.rendley.com/v1/projects/{id}/agent`

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/agent", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl "https://api.rendley.com/v1/projects/ID/agent" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/ID/agent",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/agent");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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("GET", "https://api.rendley.com/v1/projects/ID/agent", 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/projects/ID/agent")
req = Net::HTTP::Get.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"]
```

Response 200

```
{
  "data": {
    "job_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "super_agent_child_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  }
}
```

## Duplicate a project

Create a copy of an existing project, including its media assets.

POST`https://api.rendley.com/v1/projects/{id}/duplicate`

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/duplicate", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl -X POST "https://api.rendley.com/v1/projects/ID/duplicate" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.post(
    "https://api.rendley.com/v1/projects/ID/duplicate",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/duplicate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
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("POST", "https://api.rendley.com/v1/projects/ID/duplicate", 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/projects/ID/duplicate")
req = Net::HTTP::Post.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"]
```

Response 200

```
{
  "data": {
    "agent_child_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_job_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "agent_prompt": "string",
    "agent_skill": "string",
    "can_edit": true,
    "created_at": "string",
    "created_by": "string",
    "deleted_at": "string",
    "fit_duration": 0,
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "last_viewed_at": "string",
    "name": "string",
    "organization_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "project_json": "string",
    "template": {
      "fields": [
        {
          "alias": "string",
          "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "group": "string",
          "key": "string",
          "label": "string",
          "path": "string",
          "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
          "step": "string"
        }
      ],
      "version": 0
    },
    "template_mode": true,
    "thumbnail_url": "string",
    "updated_at": "string",
    "version": 0,
    "workspace_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  }
}
```

## Save a project as a template

POST`https://api.rendley.com/v1/projects/{id}/template`

Copy the project (document and files) into a user template of its workspace. Saving again from the same project overwrites that template and keeps its id; deleting the project does not affect it. Start it with POST /projects and template_id. `fields` replaces the project's template fields first, each named by its path: clips.<clip_id>.<property> (e.g. clips.<id>.text, clips.<id>.style.color), display.<property>, or media.<media_id>.url for the file behind a media. Omitted, the fields set in the editor are kept.

" }">

`id`requiredstring

Body

`fields`optionalobject[]

Replaces the project's template fields before saving; omitted keeps the ones set in the editor.

`alias`optionalstring

Name the author gave the field in the editor.

`clip_id`optionalstring

Clip a media field was promoted from.

`group`optionalstring

The clip, media or canvas the field belongs to.

`key`optionalstring

Name in POST /projects `fields`; the path when unset.

`label`optionalstring

`path`requiredstring

Document path, e.g. clips.<id>.text or media.<id>.url.

`property_id`optionalstring

Editor panel field and right-sidebar step that render it.

`step`optionalstring

`name`optionalstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/template", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "fields": [
      {
        "alias": "string",
        "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
        "group": "string",
        "key": "string",
        "label": "string",
        "path": "string",
        "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
        "step": "string"
      }
    ],
    "name": "<name>"
  }),
});
const { data } = await res.json();
```

```
curl -X POST "https://api.rendley.com/v1/projects/ID/template" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": [
      {
        "alias": "string",
        "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
        "group": "string",
        "key": "string",
        "label": "string",
        "path": "string",
        "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
        "step": "string"
      }
    ],
    "name": "<name>"
  }'
```

```
import requests

res = requests.post(
    "https://api.rendley.com/v1/projects/ID/template",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "fields": [
            {
                "alias": "string",
                "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
                "group": "string",
                "key": "string",
                "label": "string",
                "path": "string",
                "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
                "step": "string"
            }
        ],
        "name": "<name>"
    },
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/template");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["fields" => [["alias" => "string", "clip_id" => "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70", "group" => "string", "key" => "string", "label" => "string", "path" => "string", "property_id" => "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70", "step" => "string"]], "name" => "<name>"]));

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

```
package main

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

func main() {
	body := bytes.NewBufferString(`{
  "fields": [
    {
      "alias": "string",
      "clip_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "group": "string",
      "key": "string",
      "label": "string",
      "path": "string",
      "property_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "step": "string"
    }
  ],
  "name": "<name>"
}`)
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/projects/ID/template", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	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/projects/ID/template")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { fields: [{ alias: "string", clip_id: "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70", group: "string", key: "string", label: "string", path: "string", property_id: "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70", step: "string" }], name: "<name>" }.to_json

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 project's version

Retrieve the current version number of a project. The version increments on every document save; poll it to detect edits made in the studio.

GET`https://api.rendley.com/v1/projects/{id}/version`

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/version", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl "https://api.rendley.com/v1/projects/ID/version" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/ID/version",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/version");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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("GET", "https://api.rendley.com/v1/projects/ID/version", 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/projects/ID/version")
req = Net::HTTP::Get.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 a project's versions

GET`https://api.rendley.com/v1/projects/{id}/versions`

Version history of a project, newest first: saved states taken before an AI agent run edited it (agent), after a save at most every 10 minutes (timed), saved by a user (manual), and the state the last restore replaced (before_restore). How many of each kind are kept depends on the workspace owner's plan.

`id`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/versions", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl "https://api.rendley.com/v1/projects/ID/versions" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/ID/versions",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/versions");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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("GET", "https://api.rendley.com/v1/projects/ID/versions", 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/projects/ID/versions")
req = Net::HTTP::Get.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"]
```

Response 200

```
{
  "data": [
    {
      "created_at": "string",
      "created_by_name": "string",
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "kind": "agent",
      "label": "string",
      "project_version": 0
    }
  ]
}
```

## Save a project version

POST`https://api.rendley.com/v1/projects/{id}/versions`

Save the project's saved state as a manual version, with an optional label. When the newest manual version already holds that state, it is returned instead of a copy. The oldest manual version past the plan's count is deleted.

" }">

`id`requiredstring

Body

`label`optionalstring

Shown next to the version in Version history.

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/versions", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "label": "<label>"
  }),
});
const { data } = await res.json();
```

```
curl -X POST "https://api.rendley.com/v1/projects/ID/versions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "<label>"
  }'
```

```
import requests

res = requests.post(
    "https://api.rendley.com/v1/projects/ID/versions",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "label": "<label>"
    },
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/versions");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["label" => "<label>"]));

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

```
package main

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

func main() {
	body := bytes.NewBufferString(`{
  "label": "<label>"
}`)
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/projects/ID/versions", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	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/projects/ID/versions")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { label: "<label>" }.to_json

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_name": "string",
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "kind": "agent",
    "label": "string",
    "project_version": 0
  }
}
```

## Restore a project version

POST`https://api.rendley.com/v1/projects/{id}/versions/{versionId}/restore`

Make a version the project's saved state. The state it replaces is kept as the project's before_restore version (replacing the previous one), the project version goes up by one (editors still holding the older version are told the project changed), and library files the restored state uses that were deleted in the last 3 days come back. Refused while an agent works on the project.

`id`requiredstring

`versionId`requiredstring

```
const res = await fetch("https://api.rendley.com/v1/projects/ID/versions/VERSION_ID/restore", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
```

```
curl -X POST "https://api.rendley.com/v1/projects/ID/versions/VERSION_ID/restore" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```
import requests

res = requests.post(
    "https://api.rendley.com/v1/projects/ID/versions/VERSION_ID/restore",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
```

```
$ch = curl_init("https://api.rendley.com/v1/projects/ID/versions/VERSION_ID/restore");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
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("POST", "https://api.rendley.com/v1/projects/ID/versions/VERSION_ID/restore", 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/projects/ID/versions/VERSION_ID/restore")
req = Net::HTTP::Post.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"]
```

Response 200

```
{
  "data": {
    "version": 0
  }
}
```

[Previous pageWorkspaces](https://docs.rendley.com/api/workspaces/) [Next pageUploads](https://docs.rendley.com/api/uploads/)
