Shotstack API

https://shotstack.io/docs/api
Admin
Shotstack is a video, image and audio editing service that allows for the automated generation of...
Tokens:97,609
Snippets:591
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Render Status with Go

Source: https://shotstack.io/docs/api

Go language example for making an HTTP GET request to retrieve render status. This snippet includes setting up headers and the HTTP client.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/edit/{version}/render/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}


```

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

### Inspect Media using Go

Source: https://shotstack.io/docs/api

This Go example demonstrates how to make an HTTP GET request to the probe endpoint using the standard 'net/http' package. It includes setting custom headers for the request.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/edit/{version}/probe/{url}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}



```

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

### Inspect Media using Ruby

Source: https://shotstack.io/docs/api

This Ruby example uses the 'rest-client' gem to make a GET request to the probe endpoint. It includes the required headers for authentication and content type.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.shotstack.io/edit/{version}/probe/{url}',
  params: {
  }, headers: headers

p JSON.parse(result)



```

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

### Inspect Media using Node.js

Source: https://shotstack.io/docs/api

This Node.js example demonstrates how to fetch media asset information using the 'node-fetch' library. It sends a GET request to the probe endpoint with the necessary headers.

```javascript
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/edit/{version}/probe/{url}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});



```

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

### Asset Response Example

Source: https://shotstack.io/docs/api

This is an example of a successful 200 OK response when fetching an asset. It includes details like the asset's ID, owner, region, status, and URL.

```json
{
  "data": {
    "type": "asset",
    "attributes": {
      "id": "a4482cbf-e321-42a2-ac8b-947d26886840",
      "owner": "5ca6hu7s9k",
      "region": "au",
      "renderId": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7",
      "providerId": "a4482cbf-e321-42a2-ac8b-947d26886840",
      "filename": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4",
      "url": "https://cdn.shotstack.io/au/v1/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4",
      "status": "ready",
      "created": "2021-06-30T09:42:29.446Z",
      "updated": "2021-06-30T09:42:30.168Z"
    }
  }
}


```

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

### Get Render Status with Python

Source: https://shotstack.io/docs/api

Python example using the 'requests' library to get render status. This is a common and straightforward way to interact with REST APIs.

```python
import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'API_KEY'
}

r = requests.get('https://api.shotstack.io/edit/{version}/render/{id}', headers = headers)

print(r.json())

```

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

### Configure Video Clip with Advanced Properties

Source: https://shotstack.io/docs/api

Define a video clip within a track, including transcoding, trimming, volume, cropping, chroma key, transformations, and effects. This example demonstrates a complex video clip setup.

```json
{
  "clips": [
    {
      "asset": {
        "type": "video",
        "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4",
        "transcode": false,
        "trim": 2,
        "volume": 0.5,
        "volumeEffect": "none",
        "speed": 1,
        "crop": {
          "top": 0.15,
          "bottom": 0.15,
          "left": 1,
          "right": 1
        },
        "chromaKey": {
          "color": "#00b140",
          "threshold": 150,
          "halo": 100
        }
      },
      "start": 2,
      "length": 5,
      "fit": "cover",
      "scale": 0.5,
      "width": 800,
      "height": 600,
      "position": "top",
      "offset": {
        "x": 0.1,
        "y": -0.2
      },
      "transition": {
        "in": "none",
        "out": "none"
      },
      "effect": "zoomIn",
      "filter": "greyscale",
      "opacity": 0.5,
      "transform": {
        "rotate": {
          "angle": 45
        },
        "skew": {
          "x": 0.5,
          "y": 0.5
        },
        "flip": {
          "horizontal": true,
          "vertical": true
        }
      },
      "alias": "MY_VIDEO_CLIP"
    }
  ]
}
```

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

### Create Template using Ruby

Source: https://shotstack.io/docs/api

Create a video template using Ruby with the 'rest-client' gem. This example shows how to set headers and parse the JSON response.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.shotstack.io/edit/{version}/templates',
  params: {
  }, headers: headers

p JSON.parse(result)



```

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

### List Sources using Python

Source: https://shotstack.io/docs/api

Use the requests library to send a GET request to the /sources endpoint. The API key should be provided in the headers.

```python
import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'API_KEY'
}

r = requests.get('https://api.shotstack.io/ingest/{version}/sources', headers = headers)

print(r.json())


```

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

### Example Upload Response

Source: https://shotstack.io/docs/api

This is an example of a successful response when requesting a signed URL. It includes the upload ID and the signed URL for the PUT request.

```json
{
  "data": {
    "type": "upload",
    "id": "zzytey4v-32km-kq1z-aftr-3kcuqi0brad2",
    "attributes": {
      "id": "zzytey4v-32km-kq1z-aftr-3kcuqi0brad2",
      "url": "https://shotstack-ingest-api-v1-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV3NVDML6LI2ZVG&Expires=1672819007&Signature=9M76gBA%2FghV8ZYvGTp3alo5Ya%2Fk%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLXNvdXRoZWFzdC0yIkcwRQIhAJHrqMCRk7ACXuXmJICTkADbx11e2wUP0RZ3KRdN3%2BGwAiAYt%2FIHlM8rcplCgvsvqH%2BBtSrlCW%2BUeZstwuwgq45Y3iqbAwjo%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDQzMzExNTIxMTk5MiIMtFX%2Bb1klptd8HXQvKu8Cd0xpHti7cRWkPxQz3foEWSYu1U8In64Qsi6TFK%2BmiOhVnUkHK%2BLSIwF1yQFMK2oTzVXwrEFEsyqlf%2FPZ9j3OL9eLlB7G5AqbC16hjXXR3psipp0dE2uvCV2d%2BIDYgcf1MKmzE0FDfN4wyTez%2Bd%2F3y8nfAtWB%2FCB0wU8AtKNUI7hwNbCYMgCa8QUeAH2UOrriDaN379vKXK%2B1XVplhhuvLX3aC1D0St2U6lC5yaDtZbLGEyymQPhgpp5Mam6jVzHVXXX4%2FvkQSNWbDMuMFd13fqdut9uMPkq4vhZgCmyQsibC7AnrK21QopLY%2F0vhHvPUhSkzRDKjiQou0vDrbTnT4yJLY5RCs9G65yisi6jbyUUbJTUgrME7PPPihs7kM5L%2FGjhmKqe9rNPuzKC%2FISRcmVtAPleX7tqPI7H%2BuEIobS%2FE%2B1jV4oNUFQA549prw3546FXds%2FgCLKRU%2BvxUyi2yKS8U0QC%2FNLMg2p9c81%2BaDCCqxtSdBjqdAcxGASzQwP6hHbfzC2hlnxn%2Bnf4MddgpIPFxvpV18Sy9vUYSU52mrsZK%2FxPcxrg1AM94v0aaW%2FaRE1ESTF2hXJrAJZkDNDPEBQBmcP3ylj4Bf5MsP%2FCspFoF6TvXZPYkH1lSlWHT8OTOugLji7%2F9qb9a6bKzFJqvcS0EiT7v5LCOMOpVA%2FAg9RM0yerN4Zot%2FREHgCSzajNII9Xio%2F0
    },
    "expires": "2023-01-02T02:47:37.260Z"
  }
}
```

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

### List Sources using Ruby

Source: https://shotstack.io/docs/api

Employ the rest-client gem to perform a GET request to the /sources endpoint. Include your API key in the request headers.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.shotstack.io/ingest/{version}/sources',
  params: {
  }, headers: headers

p JSON.parse(result)



```

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

### Update Template HTTP Request Example

Source: https://shotstack.io/docs/api

An example of an HTTP PUT request to update a template. This shows the request line and headers.

```http
PUT https://api.shotstack.io/edit/{version}/templates/{id} HTTP/1.1
Host: api.shotstack.io
Content-Type: application/json
Accept: application/json



```

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

### List Sources using Node.js

Source: https://shotstack.io/docs/api

Use the node-fetch library to make a GET request to the /sources endpoint. The API key should be included in the request headers.

```javascript
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/ingest/{version}/sources', 
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});



```

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

### Delete Template using Go

Source: https://shotstack.io/docs/api

This Go example shows how to delete a template using the `net/http` package. It constructs a DELETE request and sends it with the API key.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.shotstack.io/edit/{version}/templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

```

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

### List Sources using cURL

Source: https://shotstack.io/docs/api

Use cURL to make a GET request to the /sources endpoint. Ensure you include your API key in the headers.

```bash
# You can also use wget
curl -X GET https://api.shotstack.io/ingest/{version}/sources \
  -H 'Accept: application/json' \
  -H 'x-api-key: API_KEY'


```

```http
GET https://api.shotstack.io/ingest/{version}/sources HTTP/1.1
Host: api.shotstack.io
Accept: application/json


```

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

### List Sources using PHP

Source: https://shotstack.io/docs/api

Utilize the Guzzle HTTP client to send a GET request to the /sources endpoint. The API key must be passed in the headers.

```php
$headers = array(
    'Accept' => 'application/json',
    'x-api-key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.shotstack.io/ingest/{version}/sources', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


```

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

### Get Render Status HTTP Request

Source: https://shotstack.io/docs/api

Example of an HTTP GET request to check render status. This shows the request line and headers.

```http
GET https://api.shotstack.io/edit/{version}/render/{id} HTTP/1.1
Host: api.shotstack.io
Accept: application/json
```

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

### Upload Media using Go (net/http)

Source: https://shotstack.io/docs/api

This Go example shows how to upload media using the standard 'net/http' package. It constructs a POST request with specified headers and a buffer for data.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.shotstack.io/edit/{version}/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

```

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

### Fetch Source using Go

Source: https://shotstack.io/docs/api

This Go example demonstrates how to construct and send a POST request to the ingest sources endpoint using the 'net/http' package. It shows setting headers and preparing the request body.

```go
package main

import (
       "bytes",
       "net/http",
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.shotstack.io/ingest/{version}/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}


```

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

### Get Asset by Render ID using Java

Source: https://shotstack.io/docs/api

Retrieve asset information using Java's built-in HttpURLConnection. This example demonstrates setting the request method, getting the response code, and reading the response body.

```java
URL obj = new URL("https://api.shotstack.io/serve/{version}/assets/render/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

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

### Render Template using Go (net/http)

Source: https://shotstack.io/docs/api

Render a template using Go's net/http package. This example shows how to set headers and send the request data.

```go
package main

import (
       "bytes",
       "net/http",
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.shotstack.io/edit/{version}/templates/render", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}


```

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

### List Sources using Go

Source: https://shotstack.io/docs/api

Use Go's net/http package to construct and execute a GET request to the /sources endpoint. The API key must be set in the request headers.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/ingest/{version}/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}



```

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

### Get Asset by Render ID using Ruby

Source: https://shotstack.io/docs/api

Make a GET request to retrieve assets by render ID using Ruby's 'rest-client' library. This example includes setting up headers and parsing the JSON response.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.shotstack.io/serve/{version}/assets/render/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
```

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

### Create Template using Python

Source: https://shotstack.io/docs/api

This Python example uses the 'requests' library to send a POST request to create a video template. It includes setting the necessary headers.

```python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'API_KEY'
}

r = requests.post('https://api.shotstack.io/edit/{version}/templates', headers = headers)

print(r.json())



```

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

### Get Render Status with Ruby

Source: https://shotstack.io/docs/api

This Ruby snippet demonstrates how to retrieve render status using the 'rest-client' gem. Ensure you have the gem installed and replace placeholders.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.shotstack.io/edit/{version}/render/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

```

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

### Fetch Source using Java

Source: https://shotstack.io/docs/api

This Java example shows how to make a POST request to the ingest sources endpoint using standard Java networking libraries. It includes setting the request method and reading the response.

```java
URL obj = new URL("https://api.shotstack.io/ingest/{version}/sources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


```

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

### Get Asset using Java

Source: https://shotstack.io/docs/api

Fetch an asset by its ID using Java's built-in `HttpURLConnection`. This example demonstrates setting the request method and reading the response.

```java
URL obj = new URL("https://api.shotstack.io/serve/{version}/assets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());



```

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

### Transfer Asset using Go (net/http)

Source: https://shotstack.io/docs/api

Transfer an asset using Go's net/http package. This example sets up headers and makes the POST request. Replace {version} and API_KEY.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.shotstack.io/serve/{version}/assets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}



```

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

### Get Render Status with Java

Source: https://shotstack.io/docs/api

Java code snippet for fetching render status using standard Java libraries. This example shows how to set up the connection and read the response.

```java
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.BufferedReader;
import java.io.InputStreamReader;

URL obj = new URL("https://api.shotstack.io/edit/{version}/render/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

```

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

### Get Render Status with PHP (Guzzle)

Source: https://shotstack.io/docs/api

Example using PHP with the Guzzle HTTP client to fetch render status. This snippet includes basic error handling for API requests.

```php
<?php

$headers = array(
    'Accept' => 'application/json',
    'x-api-key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.shotstack.io/edit/{version}/render/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

?>
```

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

### Delete Asset using Python Requests

Source: https://shotstack.io/docs/api

This Python example uses the `requests` library to delete an asset. Install the library if you haven't already, and substitute your API key and asset ID.

```python
import requests
headers = {
  'x-api-key': 'API_KEY'
}

r = requests.delete('https://api.shotstack.io/serve/{version}/assets/{id}', headers = headers)

print(r.json())

```

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

### Create Template using Node.js

Source: https://shotstack.io/docs/api

Create a video template using Node.js with the 'node-fetch' library. This example demonstrates constructing the request body and headers for the API call.

```javascript
const fetch = require('node-fetch');
const inputBody = {
  "name": "My template",
  "template": {
    "timeline": {
      "soundtrack": {
        "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3",
        "effect": "fadeIn",
        "volume": 0
      },
      "background": "string",
      "fonts": [
        {
          "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/open-sans.ttf"
        }
      ],
      "tracks": [
        {
          "clips": [
            {
              "asset": {
                "type": "video",
                "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4",
                "transcode": false,
                "trim": 2,
                "volume": 0.5,
                "volumeEffect": "none",
                "speed": 1,
                "crop": {
                  "top": 0.15,
                  "bottom": 0.15,
                  "left": 1,
                  "right": 1
                },
                "chromaKey": {
                  "color": "#00b140",
                  "threshold": 150,
                  "halo": 100
                }
              },
              "start": 2,
              "length": 5,
              "fit": "cover",
              "scale": 0.5,
              "width": 800,
              "height": 600,
              "position": "top",
              "offset": {
                "x": 0.1,
                "y": -0.2
              },
              "transition": {
                "in": "none",
                "out": "none"
              },
              "effect": "zoomIn",
              "filter": "greyscale",
              "opacity": 0.5,
              "transform": {
                "rotate": {
                  "angle": 45
                },
                "skew": {
                  "x": 0.5,
                  "y": 0.5
                },
                "flip": {
                  "horizontal": true,
                  "vertical": true
                }
              },
              "alias": "MY_VIDEO_CLIP"
            }
          ]
        }
      ],
      "cache": true
    },
    "output": {
      "format": "mp4",
      "resolution": "hd",
      "aspectRatio": "16:9",
      "size": {
        "width": 1200,
        "height": 800
      },
      "fps": 25,
      "scaleTo": "preview",
      "quality": "medium",
      "repeat": true,
      "mute": false,
      "range": {
        "start": 3,
        "length": 6
      },
      "poster": {
        "capture": 1
      },
      "thumbnail": {
        "capture": 1,
        "scale": 0.3
      },
      "destinations": [
        {
          "provider": "shotstack",
          "exclude": false
        }
      ]
    },
    "merge": [
      {
        "find": "NAME",
        "replace": "Jane"
      }
    ],
    "callback": "https://my-server.com/callback.php",
    "disk": "local",
    "instance": "s1"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/edit/{version}/templates',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});



```

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

### Get Asset by Render ID using Node.js

Source: https://shotstack.io/docs/api

Fetch asset details using the render ID with Node.js and the 'node-fetch' library. This example demonstrates setting up the request headers and handling the JSON response.

```javascript
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/serve/{version}/assets/render/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

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

### Upload Media using Node.js (node-fetch)

Source: https://shotstack.io/docs/api

This Node.js example uses the 'node-fetch' library to make a POST request for uploading media. It includes setting the necessary headers for authentication and content type.

```javascript
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/edit/{version}/upload', 
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

```

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

### Java HTTP Request to Render

Source: https://shotstack.io/docs/api

Example of making a POST request to the Shotstack render endpoint using Java's HttpURLConnection. This snippet demonstrates basic HTTP request setup and response handling.

```Java
URL obj = new URL("https://api.shotstack.io/edit/{version}/render");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

```

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

### Delete Asset using PHP Guzzle

Source: https://shotstack.io/docs/api

This PHP example uses the Guzzle HTTP client to delete an asset. Make sure Guzzle is installed and replace the placeholders with your specific API key and asset ID.

```php
'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.shotstack.io/serve/{version}/assets/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

```

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

### Upload Media using Java (HttpURLConnection)

Source: https://shotstack.io/docs/api

This Java example demonstrates uploading media using the built-in HttpURLConnection class. It sets the request method to POST and reads the response from the input stream.

```java
URL obj = new URL("https://api.shotstack.io/edit/{version}/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

```

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

### Get Source File Details (Go)

Source: https://shotstack.io/docs/api

Retrieve source file details using Go's net/http package. Ensure you replace {version} and {id} with your specific values and provide your API key.

```go
package main

import (
       "bytes",
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/ingest/{version}/sources/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

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

### Get Asset using Python

Source: https://shotstack.io/docs/api

Use the `requests` library in Python to get an asset by its ID. The response is returned as JSON.

```python
import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'API_KEY'
}

r = requests.get('https://api.shotstack.io/serve/{version}/assets/{id}', headers = headers)

print(r.json())



```

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

### Retrieve Template using Go

Source: https://shotstack.io/docs/api

Make a GET request to retrieve a template using Go's net/http package. Define the headers, including 'Accept' and 'x-api-key'. Replace {version} and {id} with your specific values.

```go
package main

import (
       "bytes",
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/edit/{version}/templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

```

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

### Fetch Source using Node.js

Source: https://shotstack.io/docs/api

This Node.js example demonstrates how to send a POST request to the ingest sources endpoint using the 'node-fetch' library. It includes a sample request body with output renditions, transcription settings, destination, and callback URL.

```javascript
const fetch = require('node-fetch');
const inputBody = {
  "url": "https://github.com/shotstack/test-media/raw/main/captioning/scott-ko.mp4",
  "outputs": {
    "renditions": [
      {
        "format": "mp4",
        "size": {
          "width": 1200,
          "height": 800
        },
        "fit": "crop",
        "resolution": "hd",
        "quality": 70,
        "fps": 25,
        "speed": {
          "speed": 1.5,
          "preservePitch": false
        },
        "keyframeInterval": 10,
        "fixOffset": true,
        "fixRotation": true,
        "enhance": {
          "audio": {
            "provider": "dolby",
            "options": {
              "preset": "studio"
            }
          }
        },
        "filename": "my-video"
      }
    ],
    "transcription": {
      "format": "vtt"
    }
  },
  "destinations": {
    "provider": "shotstack",
    "exclude": false
  },
  "callback": "https://my-server.com/callback.php"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/ingest/{version}/sources',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


```

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

### Probe Response Example

Source: https://shotstack.io/docs/api

This is an example of a successful probe response from the Shotstack API, indicating that the media asset was successfully processed and information was retrieved.

```json
{
  "success": true,
  "message": "Created",
  "response": {}
}


```

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

### Get Render Status with Node.js

Source: https://shotstack.io/docs/api

Use Node.js and the 'node-fetch' library to get render status. Replace placeholders and ensure your API key is correctly set.

```javascript
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://api.shotstack.io/edit/{version}/render/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

```

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

### Template List Response Example

Source: https://shotstack.io/docs/api

This is an example of a successful JSON response when listing templates from the Shotstack API. It includes details about the owner and an array of available templates.

```json
{
  "success": true,
  "message": "OK",
  "response": {
    "owner": "5ca6hu7s9k",
    "templates": [
      {
        "id": "f5493c17-d01f-445c-bb49-535fae65f219",
        "name": "My template",
        "created": "2022-06-10T12:50:21.455Z",
        "updated": "2022-06-22T08:24:30.168Z"
      }
    ]
  }
}

```

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

### Get Asset using Go

Source: https://shotstack.io/docs/api

Retrieve an asset by its ID using Go's `net/http` package. This snippet shows how to set up the request headers and perform the GET request.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.shotstack.io/serve/{version}/assets/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}



```

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

### Get Source File Details (Ruby)

Source: https://shotstack.io/docs/api

Fetch source file details using Ruby with the 'rest-client' gem. Replace {version} and {id} with your specific values and provide your API key.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.shotstack.io/ingest/{version}/sources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
```

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

### Upload Media using Ruby (rest-client)

Source: https://shotstack.io/docs/api

This Ruby example utilizes the 'rest-client' gem to perform a POST request for media uploads. It defines the required headers and sends an empty JSON payload.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.shotstack.io/edit/{version}/upload',
  params: {
  }, headers: headers

p JSON.parse(result)

```

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

### List Sources using Java

Source: https://shotstack.io/docs/api

Use Java's built-in HttpURLConnection to make a GET request to the /sources endpoint. Ensure the API key is included in the request headers.

```java
URL obj = new URL("https://api.shotstack.io/ingest/{version}/sources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());



```
Tokens:
Raw