POST Api/V1/Studio/Video/Generate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
campaignId	string	None.
sourceAssetId	string	None.
sourceImageUrl	string	None.
endImageUrl	string	None.
referenceImages	Collection of string	None.
ratio	string	None.
sourceWidth	integer	None.
sourceHeight	integer	None.
model	string	None.
tier	string	None.
duration	integer	None.
audio	boolean	None.
seed	integer	None.
loop	boolean	None.
prompt	string	None.
userPrompt	string	None.
panelCount	integer	None.
engine	string	None.
textOverlay	Collection of Object	None.
inputFrames	Collection of RunwayInputFrame	None.
productImages	Collection of string	None.
styleImages	Collection of string	None.
productInfo	string	None.
userConcept	string	None.
title	string	None.
edit	boolean	None.
sourceVideoAssetId	string	None.
sourceVideoUrl	string	None.
sourceVideoSeconds	decimal number	None.
editDepth	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "campaignId": "sample string 1",
  "sourceAssetId": "sample string 2",
  "sourceImageUrl": "sample string 3",
  "endImageUrl": "sample string 4",
  "referenceImages": [
    "sample string 1",
    "sample string 2"
  ],
  "ratio": "sample string 5",
  "sourceWidth": 6,
  "sourceHeight": 7,
  "model": "sample string 8",
  "tier": "sample string 9",
  "duration": 1,
  "audio": true,
  "seed": 1,
  "loop": true,
  "prompt": "sample string 11",
  "userPrompt": "sample string 12",
  "panelCount": 1,
  "engine": "sample string 13",
  "textOverlay": null,
  "inputFrames": [
    {
      "dataUrl": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3"
    },
    {
      "dataUrl": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3"
    }
  ],
  "productImages": [
    "sample string 1",
    "sample string 2"
  ],
  "styleImages": [
    "sample string 1",
    "sample string 2"
  ],
  "productInfo": "sample string 14",
  "userConcept": "sample string 15",
  "title": "sample string 18",
  "edit": true,
  "sourceVideoAssetId": "sample string 20",
  "sourceVideoUrl": "sample string 21",
  "sourceVideoSeconds": 1.1,
  "editDepth": 1
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RunwayVideoRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.