Sync

https://sync.so/docs
Admin
Sync is an AI video platform that automatically syncs lip movements in any video to match audio...
Tokens:118,974
Snippets:943
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Execute the Quick Start Script

Source: https://sync.so/docs/developer-guides/sdk-python

Run the completed quickstart script from the terminal.

```bash
python quickstart.py
```

--------------------------------

### Install the SDK

Source: https://sync.so/docs/developer-guides/sdk-python

Install the package via pip, preferably within a virtual environment.

```bash
pip install syncsdk
```

```bash
python -m venv .venv
source .venv/bin/activate  # macOS/Linux
pip install syncsdk
```

--------------------------------

### Install Sync Labs Node Manually

Source: https://sync.so/docs/plugins-and-extensions/comfy-ui

Perform a manual installation by cloning the repository and installing dependencies.

```bash
# Inside the custom_nodes folder
git clone https://github.com/synchronicity-labs/sync-comfyui.git
cd sync-comfyui/
pip install -r requirements.txt
```

--------------------------------

### Install the Sync Labs SDK

Source: https://sync.so/docs/developer-guides/sdk-typescript

Commands to install the SDK using common package managers.

```bash
# npm
npm i @sync.so/sdk

# yarn
yarn add @sync.so/sdk

# pnpm
pnpm add @sync.so/sdk
```

--------------------------------

### Create Project SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/projects-api/create

Implementation examples for creating a project using the official SDK and various HTTP client libraries.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.projects.create(
    name="My API Project",
)
```

```javascript
const url = 'https://api.sync.so/v2/projects';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"My API Project"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/projects"

	payload := strings.NewReader("{\n  \"name\": \"My API Project\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/projects")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My API Project\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/projects")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My API Project\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sync.so/v2/projects', [
  'body' => '{
  "name": "My API Project"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/projects");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"My API Project\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["name": "My API Project"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/projects")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Create Batch SDK and HTTP Client Examples

Source: https://sync.so/docs/api-reference/api/batch-api/create

Implementation examples for creating a batch using various programming languages and HTTP clients.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.batch.create(
    input="example_input",
)
```

```javascript
const url = 'https://api.sync.so/v2/batch';
const form = new FormData();
form.append('input', '<file1>');
form.append('webhook_url', 'https://your-webhook-url.com/batch-webhook');
form.append('dry_run', 'false');

const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/batch"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"input\"; filename=\"<file1>\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"webhook_url\"\r\n\r\nhttps://your-webhook-url.com/batch-webhook\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"dry_run\"\r\n\r\nfalse\r\n-----011000010111000001101001--\r\n")

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

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/batch")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"input\"; filename=\"<file1>\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"webhook_url\"\r\n\r\nhttps://your-webhook-url.com/batch-webhook\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"dry_run\"\r\n\r\nfalse\r\n-----011000010111000001101001--\r\n"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/batch")
  .header("x-api-key", "<apiKey>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"input\"; filename=\"<file1>\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"webhook_url\"\r\n\r\nhttps://your-webhook-url.com/batch-webhook\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"dry_run\"\r\n\r\nfalse\r\n-----011000010111000001101001--\r\n")
  .asString();
```

--------------------------------

### Get Batch SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/batch-api/get

Various implementations for retrieving batch details using the Sync SDK or standard HTTP requests.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.batch.get(
    id="batch_abc123",
)
```

```javascript
const url = 'https://api.sync.so/v2/batch/batch_abc123';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/batch/batch_abc123"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/batch/batch_abc123")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sync.so/v2/batch/batch_abc123")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/batch/batch_abc123', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/batch/batch_abc123");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/batch/batch_abc123")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Sync-3 Generation SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/generate-api/create

Implementation examples for creating a sync-3 generation across various programming languages.

```python
from sync import Sync
from sync.common import Video

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.generations.create(
    model="sync-3",
    input=[
        Video(
            type="video",
            url="https://assets.sync.so/docs/example-video.mp4",
        ),
        Video(
            type="audio",
            url="https://assets.sync.so/docs/example-audio.wav",
        )
    ],
)
```

```javascript
const url = 'https://api.sync.so/v2/generate';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"model":"sync-3","input":[{"type":"video","url":"https://assets.sync.so/docs/example-video.mp4"},{"type":"audio","url":"https://assets.sync.so/docs/example-audio.wav"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/generate"

	payload := strings.NewReader("{\n  \"model\": \"sync-3\",\n  \"input\": [\n    {\n      \"type\": \"video\",\n      \"url\": \"https://assets.sync.so/docs/example-video.mp4\"\n    },\n    {\n      \"type\": \"audio\",\n      \"url\": \"https://assets.sync.so/docs/example-audio.wav\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/generate")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"sync-3\",\n  \"input\": [\n    {\n      \"type\": \"video\",\n      \"url\": \"https://assets.sync.so/docs/example-video.mp4\"\n    },\n    {\n      \"type\": \"audio\",\n      \"url\": \"https://assets.sync.so/docs/example-audio.wav\"\n    }\n  ]\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/generate")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"sync-3\",\n  \"input\": [\n    {\n      \"type\": \"video\",\n      \"url\": \"https://assets.sync.so/docs/example-video.mp4\"\n    },\n    {\n      \"type\": \"audio\",\n      \"url\": \"https://assets.sync.so/docs/example-audio.wav\"\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sync.so/v2/generate', [
  'body' => '{
  "model": "sync-3",
  "input": [
    {
      "type": "video",
      "url": "https://assets.sync.so/docs/example-video.mp4"
    },
    {
      "type": "audio",
      "url": "https://assets.sync.so/docs/example-audio.wav"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/generate");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"model\": \"sync-3\",\n  \"input\": [\n    {\n      \"type\": \"video\",\n      \"url\": \"https://assets.sync.so/docs/example-video.mp4\"\n    },\n    {\n      \"type\": \"audio\",\n      \"url\": \"https://assets.sync.so/docs/example-audio.wav\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

--------------------------------

### Attach Asset SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/projects/attach-asset

Examples demonstrating how to attach an asset using the official SDK or standard HTTP client libraries.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.projects.attach_asset(
    id="612bb64a-e7f4-40c1-977b-3e9797845637",
    asset_id="8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b",
)
```

```javascript
const url = 'https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"assetId":"8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets"

	payload := strings.NewReader("{\n  \"assetId\": \"8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assetId\": \"8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assetId\": \"8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets', [
  'body' => '{
  "assetId": "8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"assetId\": \"8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["assetId": "8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637/assets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### List Batches SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/batch-api/list

Implementation examples for listing batches using the official SDK or standard HTTP requests in various languages.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.batch.list()
```

```javascript
const url = 'https://api.sync.so/v2/batch';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/batch"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/batch")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sync.so/v2/batch")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/batch', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/batch");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/batch")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Update Project SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/projects-api/update

Implementation examples for updating a project using the official SDK and various HTTP client libraries.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.projects.update(
    id="612bb64a-e7f4-40c1-977b-3e9797845637",
    name="Renamed Project",
)
```

```javascript
const url = 'https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"Renamed Project"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637"

	payload := strings.NewReader("{\n  \"name\": \"Renamed Project\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Renamed Project\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Renamed Project\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637', [
  'body' => '{
  "name": "Renamed Project"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637");
var request = new RestRequest(Method.PATCH);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Renamed Project\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["name": "Renamed Project"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/projects/612bb64a-e7f4-40c1-977b-3e9797845637")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Set up the Python environment

Source: https://sync.so/docs/tutorials/personalized-video-messaging

Create a virtual environment and install the necessary dependencies from requirements.txt.

```bash
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

--------------------------------

### List Projects SDK and HTTP Client Examples

Source: https://sync.so/docs/api-reference/api/projects-api/list

Code examples for interacting with the List Projects endpoint using various programming languages and HTTP clients.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.projects.list(
    limit=10,
    sort_by="updatedAt",
)
```

```javascript
const url = 'https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/projects?limit=10&sortBy=updatedAt")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Install TypeScript SDK

Source: https://sync.so/docs/product/troubleshooting

Install the official TypeScript SDK package.

```bash
npm i @sync.so/sdk
```

--------------------------------

### Install ComfyUI via Comfy-CLI

Source: https://sync.so/docs/plugins-and-extensions/comfy-ui

Use the recommended Comfy-CLI tool to install the ComfyUI environment.

```bash
# Install comfy-cli 
pip install comfy-cli 

# Install ComfyUI
comfy install
```

--------------------------------

### Update Asset SDK and HTTP Examples

Source: https://sync.so/docs/api-reference/api/assets-api/update

Implementation examples for updating an asset using the official SDK or standard HTTP client libraries.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.assets.update(
    id="550e8400-e29b-41d4-a716-446655440000",
    name="Renamed asset",
)
```

```javascript
const url = 'https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"Renamed asset"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000"

	payload := strings.NewReader("{\n  \"name\": \"Renamed asset\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Renamed asset\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Renamed asset\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000', [
  'body' => '{
  "name": "Renamed asset"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000");
var request = new RestRequest(Method.PATCH);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Renamed asset\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["name": "Renamed asset"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/assets/550e8400-e29b-41d4-a716-446655440000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### TTS API SDK and HTTP Client Examples

Source: https://sync.so/docs/api-reference/api/tts-api/create

Implementation examples for the TTS create endpoint using various SDKs and HTTP clients.

```python
from sync import Sync

client = Sync(
    api_key="YOUR_API_KEY_HERE",
)

client.tts.create(
    script="Hey — thanks for trying sync. labs.",
    voice_id="EXAVITQu4vr4xnSDxMaL",
    provider="elevenlabs",
)
```

```javascript
const url = 'https://api.sync.so/v2/tts';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"script":"Hey — thanks for trying sync. labs.","voiceId":"EXAVITQu4vr4xnSDxMaL","provider":"elevenlabs"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/tts"

	payload := strings.NewReader("{\n  \"script\": \"Hey — thanks for trying sync. labs.\",\n  \"voiceId\": \"EXAVITQu4vr4xnSDxMaL\",\n  \"provider\": \"elevenlabs\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/tts")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"script\": \"Hey — thanks for trying sync. labs.\",\n  \"voiceId\": \"EXAVITQu4vr4xnSDxMaL\",\n  \"provider\": \"elevenlabs\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/tts")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"script\": \"Hey — thanks for trying sync. labs.\",\n  \"voiceId\": \"EXAVITQu4vr4xnSDxMaL\",\n  \"provider\": \"elevenlabs\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sync.so/v2/tts', [
  'body' => '{
  "script": "Hey — thanks for trying sync. labs.",
  "voiceId": "EXAVITQu4vr4xnSDxMaL",
  "provider": "elevenlabs"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/tts");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"script\": \"Hey — thanks for trying sync. labs.\",\n  \"voiceId\": \"EXAVITQu4vr4xnSDxMaL\",\n  \"provider\": \"elevenlabs\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "script": "Hey — thanks for trying sync. labs.",
  "voiceId": "EXAVITQu4vr4xnSDxMaL",
  "provider": "elevenlabs"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/tts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```
Tokens:
Raw