Rendley docs

API reference

Social

List connected social accounts

Social accounts connected to the workspace. Connect them in the Rendley app (Social media); use their ids as account_ids when creating a post.

GEThttps://api.rendley.com/v1/social/accounts

Don't have one? Create an API key

const res = await fetch("https://api.rendley.com/v1/social/accounts?workspace_id=WORKSPACE_ID", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/social/accounts?workspace_id=WORKSPACE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
import requests

res = requests.get(
    "https://api.rendley.com/v1/social/accounts?workspace_id=WORKSPACE_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/social/accounts?workspace_id=WORKSPACE_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/social/accounts?workspace_id=WORKSPACE_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/social/accounts?workspace_id=WORKSPACE_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": [
    {
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "photo_url": "string",
      "platform": "string",
      "reconnect_required": true,
      "token_expires_at": "string",
      "username": "string"
    }
  ]
}

List social posts

One page of the workspace's scheduled, published and failed posts, one per account, by publish time.

GEThttps://api.rendley.com/v1/social/posts

Don't have one? Create an API key

const res = await fetch("https://api.rendley.com/v1/social/posts?workspace_id=WORKSPACE_ID", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();
curl "https://api.rendley.com/v1/social/posts?workspace_id=WORKSPACE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
import requests

res = requests.get(
    "https://api.rendley.com/v1/social/posts?workspace_id=WORKSPACE_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/social/posts?workspace_id=WORKSPACE_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/social/posts?workspace_id=WORKSPACE_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/social/posts?workspace_id=WORKSPACE_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": [
    {
      "account_username": "string",
      "caption": "string",
      "created_at": "string",
      "error": "string",
      "error_code": "string",
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "metrics": {
        "comments": 0,
        "likes": 0,
        "saves": 0,
        "shares": 0,
        "views": 0
      },
      "platform": "string",
      "platform_options": {
        "instagram": {
          "placement": "reels",
          "share_to_feed": true
        },
        "tiktok": {
          "allow_comment": true,
          "allow_duet": true,
          "allow_stitch": true,
          "is_ai_generated": true,
          "privacy_status": "public"
        },
        "youtube": {
          "made_for_kids": true,
          "privacy_status": "public",
          "tags": [
            {}
          ],
          "title": "string"
        }
      },
      "project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "result": {},
      "scheduled_at": "string",
      "status": "string",
      "thumbnail_url": "string"
    }
  ]
}

Publish or schedule a post

POSThttps://api.rendley.com/v1/social/posts

Posts a video or image to the given connected accounts now, or at scheduled_at. Creates one post per account. If some accounts fail after others went out, the call still succeeds and the failed ones come back with status failed and an error, so retrying never posts twice. media_url can be any public HTTPS link to the file, for example a Rendley export URL: posting now hands the link to Post for Me as is; a scheduled post copies the file first, so the link may expire before the scheduled time. Requires a plan with social publishing.

Don't have one? Create an API key

Body

Ids from GET /social/accounts.

Checked against each target platform's limit, e.g. 280 characters on X.

Per-platform caption keyed by platform, e.g. {"x": "..."}; overrides caption for that platform.

Public HTTPS link to a jpeg/png/webp image used as the video's thumbnail on YouTube, Instagram, Facebook and Pinterest; other platforms pick their own.

Public HTTPS link to an mp4/mov video or a jpeg/png/webp/gif image, e.g. an export URL.

platform_optionsoptionalobject

Settings only some platforms use.

Used for YouTube accounts; the caption becomes the video description.

The Rendley project the video comes from, shown with the post in the app.

RFC 3339 time to publish at; omit to publish now.

Preview image the app shows with the post; not sent to the platforms.

const res = await fetch("https://api.rendley.com/v1/social/posts", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "account_ids": [
      "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
    ],
    "media_url": "<media_url>",
    "workspace_id": "<workspace_id>"
  }),
});
const { data } = await res.json();
curl -X POST "https://api.rendley.com/v1/social/posts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "account_ids": [
      "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
    ],
    "media_url": "<media_url>",
    "workspace_id": "<workspace_id>"
  }'
import requests

res = requests.post(
    "https://api.rendley.com/v1/social/posts",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "account_ids": [
            "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
        ],
        "media_url": "<media_url>",
        "workspace_id": "<workspace_id>"
    },
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/social/posts");
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(["account_ids" => ["3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"], "media_url" => "<media_url>", "workspace_id" => "<workspace_id>"]));

$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(`{
  "account_ids": [
    "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"
  ],
  "media_url": "<media_url>",
  "workspace_id": "<workspace_id>"
}`)
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/social/posts", 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/social/posts")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { account_ids: ["3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70"], media_url: "<media_url>", workspace_id: "<workspace_id>" }.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": [
    {
      "account_username": "string",
      "caption": "string",
      "created_at": "string",
      "error": "string",
      "error_code": "string",
      "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "metrics": {
        "comments": 0,
        "likes": 0,
        "saves": 0,
        "shares": 0,
        "views": 0
      },
      "platform": "string",
      "platform_options": {
        "instagram": {
          "placement": "reels",
          "share_to_feed": true
        },
        "tiktok": {
          "allow_comment": true,
          "allow_duet": true,
          "allow_stitch": true,
          "is_ai_generated": true,
          "privacy_status": "public"
        },
        "youtube": {
          "made_for_kids": true,
          "privacy_status": "public",
          "tags": [
            {}
          ],
          "title": "string"
        }
      },
      "project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
      "result": {},
      "scheduled_at": "string",
      "status": "string",
      "thumbnail_url": "string"
    }
  ]
}

Update a scheduled post

Changes the time, caption or platform settings of a post that hasn't started publishing. Only its author or the workspace owner can.

PUThttps://api.rendley.com/v1/social/posts/{id}

Don't have one? Create an API key

Body

New caption; omit to keep the current one.

platform_optionsoptionalobject

Replaces the post's platform settings; omit to keep the current ones.

Used for YouTube accounts; the caption becomes the video description.

RFC 3339 time to publish at; omit to keep the current one.

const res = await fetch("https://api.rendley.com/v1/social/posts/ID", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "caption": "<caption>",
    "platform_options": {
      "instagram": {
        "placement": "reels",
        "share_to_feed": true
      },
      "tiktok": {
        "allow_comment": true,
        "allow_duet": true,
        "allow_stitch": true,
        "is_ai_generated": true,
        "privacy_status": "public"
      },
      "youtube": {
        "made_for_kids": true,
        "privacy_status": "public",
        "tags": [
          "string"
        ],
        "title": "string"
      }
    },
    "scheduled_at": "<scheduled_at>"
  }),
});
const { data } = await res.json();
curl -X PUT "https://api.rendley.com/v1/social/posts/ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "caption": "<caption>",
    "platform_options": {
      "instagram": {
        "placement": "reels",
        "share_to_feed": true
      },
      "tiktok": {
        "allow_comment": true,
        "allow_duet": true,
        "allow_stitch": true,
        "is_ai_generated": true,
        "privacy_status": "public"
      },
      "youtube": {
        "made_for_kids": true,
        "privacy_status": "public",
        "tags": [
          "string"
        ],
        "title": "string"
      }
    },
    "scheduled_at": "<scheduled_at>"
  }'
import requests

res = requests.put(
    "https://api.rendley.com/v1/social/posts/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "caption": "<caption>",
        "platform_options": {
            "instagram": {
                "placement": "reels",
                "share_to_feed": True
            },
            "tiktok": {
                "allow_comment": True,
                "allow_duet": True,
                "allow_stitch": True,
                "is_ai_generated": True,
                "privacy_status": "public"
            },
            "youtube": {
                "made_for_kids": True,
                "privacy_status": "public",
                "tags": [
                    "string"
                ],
                "title": "string"
            }
        },
        "scheduled_at": "<scheduled_at>"
    },
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/social/posts/ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["caption" => "<caption>", "platform_options" => ["instagram" => ["placement" => "reels", "share_to_feed" => true], "tiktok" => ["allow_comment" => true, "allow_duet" => true, "allow_stitch" => true, "is_ai_generated" => true, "privacy_status" => "public"], "youtube" => ["made_for_kids" => true, "privacy_status" => "public", "tags" => ["string"], "title" => "string"]], "scheduled_at" => "<scheduled_at>"]));

$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(`{
  "caption": "<caption>",
  "platform_options": {
    "instagram": {
      "placement": "reels",
      "share_to_feed": true
    },
    "tiktok": {
      "allow_comment": true,
      "allow_duet": true,
      "allow_stitch": true,
      "is_ai_generated": true,
      "privacy_status": "public"
    },
    "youtube": {
      "made_for_kids": true,
      "privacy_status": "public",
      "tags": [
        "string"
      ],
      "title": "string"
    }
  },
  "scheduled_at": "<scheduled_at>"
}`)
	req, _ := http.NewRequest("PUT", "https://api.rendley.com/v1/social/posts/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/social/posts/ID")
req = Net::HTTP::Put.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { caption: "<caption>", platform_options: { instagram: { placement: "reels", share_to_feed: true }, tiktok: { allow_comment: true, allow_duet: true, allow_stitch: true, is_ai_generated: true, privacy_status: "public" }, youtube: { made_for_kids: true, privacy_status: "public", tags: ["string"], title: "string" } }, scheduled_at: "<scheduled_at>" }.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": {
    "account_username": "string",
    "caption": "string",
    "created_at": "string",
    "error": "string",
    "error_code": "string",
    "id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "metrics": {
      "comments": 0,
      "likes": 0,
      "saves": 0,
      "shares": 0,
      "views": 0
    },
    "platform": "string",
    "platform_options": {
      "instagram": {
        "placement": "reels",
        "share_to_feed": true
      },
      "tiktok": {
        "allow_comment": true,
        "allow_duet": true,
        "allow_stitch": true,
        "is_ai_generated": true,
        "privacy_status": "public"
      },
      "youtube": {
        "made_for_kids": true,
        "privacy_status": "public",
        "tags": [
          "string"
        ],
        "title": "string"
      }
    },
    "project_id": "3f0d5a4e-3d2a-4c1f-9b3e-2a1c4d5e6f70",
    "result": {},
    "scheduled_at": "string",
    "status": "string",
    "thumbnail_url": "string"
  }
}

Cancel a scheduled post

Cancels a post that hasn't started publishing, or hides a failed one. Only its author or the workspace owner can.

DELETEhttps://api.rendley.com/v1/social/posts/{id}

Don't have one? Create an API key

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

res = requests.delete(
    "https://api.rendley.com/v1/social/posts/ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]
$ch = curl_init("https://api.rendley.com/v1/social/posts/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/social/posts/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/social/posts/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"]