|
1 | 1 | /** |
2 | 2 | * Shotstack |
3 | | - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> |
| 3 | + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> |
4 | 4 | * |
5 | 5 | * The version of the OpenAPI document: v1 |
6 | 6 | * |
|
50 | 50 |
|
51 | 51 | /** |
52 | 52 | * Delete Asset |
53 | | - * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 53 | + * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} |
54 | 54 | * @param {String} id The id of the asset in UUID format |
55 | 55 | * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response |
56 | 56 | */ |
|
86 | 86 |
|
87 | 87 | /** |
88 | 88 | * Delete Asset |
89 | | - * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 89 | + * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} |
90 | 90 | * @param {String} id The id of the asset in UUID format |
91 | 91 | * @return {Promise} a {@link https://www.promisejs.org/|Promise} |
92 | 92 | */ |
|
100 | 100 |
|
101 | 101 | /** |
102 | 102 | * Get Asset |
103 | | - * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 103 | + * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
104 | 104 | * @param {String} id The id of the asset in UUID format |
105 | 105 | * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetResponse} and HTTP response |
106 | 106 | */ |
|
136 | 136 |
|
137 | 137 | /** |
138 | 138 | * Get Asset |
139 | | - * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 139 | + * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
140 | 140 | * @param {String} id The id of the asset in UUID format |
141 | 141 | * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetResponse} |
142 | 142 | */ |
|
150 | 150 |
|
151 | 151 | /** |
152 | 152 | * Get Asset by Render ID |
153 | | - * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 153 | + * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
154 | 154 | * @param {String} id The render id associated with the asset in UUID format |
155 | 155 | * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetRenderResponse} and HTTP response |
156 | 156 | */ |
|
186 | 186 |
|
187 | 187 | /** |
188 | 188 | * Get Asset by Render ID |
189 | | - * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
| 189 | + * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} |
190 | 190 | * @param {String} id The render id associated with the asset in UUID format |
191 | 191 | * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetRenderResponse} |
192 | 192 | */ |
|
0 commit comments