Submit a render job

curl --request POST \
  --url https://app.autoposting.ai/api-proxy/clips/{clipId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "editRevision": 3,
  "candidateId": "cand_01",
  "formats": [
    "9:16"
  ]
}
'

import requests

url = "https://app.autoposting.ai/api-proxy/clips/{clipId}/render"

payload = {
    "editRevision": 3,
    "candidateId": "cand_01",
    "formats": ["9:16"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({editRevision: 3, candidateId: 'cand_01', formats: ['9:16']})
};

fetch('https://app.autoposting.ai/api-proxy/clips/{clipId}/render', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.autoposting.ai/api-proxy/clips/{clipId}/render",
  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([
    'editRevision' => 3,
    'candidateId' => 'cand_01',
    'formats' => [
        '9:16'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.autoposting.ai/api-proxy/clips/{clipId}/render"

	payload := strings.NewReader("{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.autoposting.ai/api-proxy/clips/{clipId}/render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.autoposting.ai/api-proxy/clips/{clipId}/render")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "jobIds": [
      "job_01HXYZ"
    ],
    "activeJobIds": [
      "job_01HXYZ"
    ],
    "reusedJobIds": []
  }
}

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}

POST

clips

{clipId}

render

Submit a render job

curl --request POST \
  --url https://app.autoposting.ai/api-proxy/clips/{clipId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "editRevision": 3,
  "candidateId": "cand_01",
  "formats": [
    "9:16"
  ]
}
'

import requests

url = "https://app.autoposting.ai/api-proxy/clips/{clipId}/render"

payload = {
    "editRevision": 3,
    "candidateId": "cand_01",
    "formats": ["9:16"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({editRevision: 3, candidateId: 'cand_01', formats: ['9:16']})
};

fetch('https://app.autoposting.ai/api-proxy/clips/{clipId}/render', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.autoposting.ai/api-proxy/clips/{clipId}/render",
  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([
    'editRevision' => 3,
    'candidateId' => 'cand_01',
    'formats' => [
        '9:16'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.autoposting.ai/api-proxy/clips/{clipId}/render"

	payload := strings.NewReader("{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.autoposting.ai/api-proxy/clips/{clipId}/render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.autoposting.ai/api-proxy/clips/{clipId}/render")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"editRevision\": 3,\n  \"candidateId\": \"cand_01\",\n  \"formats\": [\n    \"9:16\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "jobIds": [
      "job_01HXYZ"
    ],
    "activeJobIds": [
      "job_01HXYZ"
    ],
    "reusedJobIds": []
  }
}

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}

Authorizations

Authorization

string

header

required

API key as Authorization: Bearer sk-social-...

Path Parameters

clipId

string

required

Body

application/json

editRevision

integer

required

The clip's current editRevision from GET /clips/{clipId}. A stale value returns 409.

Required range: x >= 0

Example:

3

candidateId

string

Render only this candidate. Omit to render the clip's candidates.

Example:

"cand_01"

formats

enum<string>[]

Output aspect ratios. Default ["9:16"].

Available options:

9:16,

16:9,

1:1,

4:5

Example:

["9:16"]

Response

Render jobs queued. Poll GET /clips/{clipId} until the candidate's renderStatus is completed.

success

boolean

Example:

true

data

object

Show child attributes

Overview

Agents

API Keys

Auth

Billing

Brands

Carousels

Clips

Knowledge Base

Notifications

Organizations

Platform OAuth

Posts

Teams

Usage

Webhooks

Submit a render job

Authorizations

Path Parameters

Body

Response