POST gen3/actone

Drive your image or video character performance using simple video and audio inputs.

October 28, 2024 (December 10, 2024)

Request Headers
Request Body
Responses
Model
Examples
Try It

Runway AI Tools » Audio tools » Text/Image to Video » Gen-3 Alpha » Act-One.

Creating with Act-One on Gen-3 Alpha and Turbo.

Please be aware that Runway’s moderation system analyzes your image and text prompts and may fail task with moderation message if the prompt is determined to be offensive. Runway monitors the rate and the number of moderated tasks, which may result in your account being suspended when the internal threshold is exceeded.

https://api.useapi.net/v1/runwayml/gen3/actone

Request Headers

Authorization: Bearer {API token}
Content-Type: application/json
# Alternatively you can use multipart/form-data
# Content-Type: multipart/form-data

API token is required, see Setup useapi.net for details.

Request Body

{
    "driving_assetId": "Required assetId of the video asset you want to use to drive performance",
    "character_assetId": "Required assetId of the image or video asset for your character reference",
    "exploreMode": true,
    "motion_multiplier": 5,
    "aspect_ratio": "portrait",
    "replyUrl": "Place your call back URL here",
    "replyRef": "Place your reference id here",
    "maxJobs": 5,
}

driving_assetId is required. Specify the video asset you want to use to drive performance. Use GET /assets/?mediaType=video to see the list of video assets.
character_assetId is required. Specify the image or video asset for your character reference. Use GET /assets/?mediaType=image to see the list of image or video assets.
motion_multiplier is optional. Higher values allow for more expressive motion while lower values result in more stability.
Valid range: 1…5, default 3.
aspect_ratio is optional. This parameter is only applicable for image character_assetId, video character_assetId will retain the original format.
Supported values: landscape (default), portrait.
exploreMode is optional. Set to true if you have a Runway Unlimited plan and wish to execute relaxed generation. You are not charged credits for Explore mode generations.
replyUrl is optional, if not provided value from account will be used.
Place here your callback URL. API will call the provided replyUrl once Runway task completed or failed.
Maximum length 1024 characters.
We recommend using sites like webhook.site to test callback URL functionality.
replyRef is optional, place here your reference id which will be stored and returned along with this Runway task response / result.
Maximum length 1024 characters.
maxJobs is optional, if not provided value for referenced by video assetId account will be used.
Valid range: 1…10.

Responses

200 OK

Use returned taskId to retrieve task status and results using GET /tasks/taskId. The generated video url can be found in the artifacts array of the task with the status SUCCEEDED.

If you specify the optional parameter replyUrl the API will call the provided replyUrl with task progress updates until the task is complete or fails.

{
  "taskId": "user:user_id-runwayml:account_email-task:task_uuid",
  "id": "<uuid>",
  "name": "<name>",
  "image": null,
  "createdAt": "2024-08-01T01:02:03.456Z",
  "updatedAt": "2024-08-01T01:02:03.456Z",
  "taskType": "gen3a",
  "options": {
      "name": "<name>",
      "driving_video": "<driving video url>",
      "character_image": "<character image url>",
      "motion_multiplier": 3,
      "seed": 0,
      "seconds": 5,
      "exploreMode": true,
      "watermark": false,
      "width": 1280,
      "height": 768,
      "assetGroupName": "Generative Video",
      "recordingEnabled": true
  },  
  "status": "PENDING",
  "error": null,
  "progressText": null,
  "progressRatio": null,
  "estimatedTimeToStartSeconds": 0,
  "artifacts": [],
  "sharedAsset": null,
  "features": {
      "storageGB": 500,
      "numPlanCredits_permitted": 2250,
      "numPlanCredits_used": 1315
  },    
  "replyUrl": "https://webhook.site/abc",
  "replyRef": "<your optional reference id>",
  "code": 200
}

400 Bad Request

{
  "error": "<Error message>",
  "code": 400
}

401 Unauthorized

{
  "error": "Unauthorized",
  "code": 401
}

404 Not Found

{
    "error": "Unable to retrieve assetId <uuid> (Not found.)",
    "code": 404
}

412 Insufficient credits

You do not have enough credits to run this task.

{
    "error": "You do not have enough credits to run this task."
}

429 Too Many Requests

Wait in a loop for at least 10..30 seconds and retry again.

There are two possible cases for API response 429:

API query is full and can not accept new gen3/actone requests. Size of query defined by maxJobs optional parameter.

{
    "error": "Account <Runway account email> is busy executing <Account maxJobs> tasks",
    "runningTasks": {
        "<Runway account email>": [
            {
                "email": "<Runway account email>",
                "taskId": "user:user_id-runwayml:account_email-task:task_#1_uuid",
                "id": "<uuid>",
                "replyUrl": "<replyUrl if provided>",
                "replyRef": "<replyRef if provided>"
            },
            {
                "email": "<Runway account email>",
                "taskId": "user:user_id-runwayml:account_email-task:task_#N_uuid",
                "id": "<uuid>",
                "replyUrl": "<replyUrl if provided>",
                "replyRef": "<replyRef if provided>"
            }
        ]
    },
    "code": 429
}

The API received an HTTP response status 429 from Runway. Runway has dynamic query management and may limit the number of simultaneously executed tasks based on internal service load and policies.

{
    "error": "You have too many tasks running or pending. Please wait for some of them to finish before starting more."
}

Model

{ // TypeScript, all fields are optional
  taskId: string
  id: string
  name: string
  image: any
  createdAt: string
  updatedAt: string
  taskType: string
  options: {
      name: string
      seed: number
      exploreMode: boolean
      watermark: boolean
      seconds: number
      driving_video: string
      character_image: string
      character_video: string
      motion_multiplier: number      
      width: number
      height: number
      flip: boolean
      assetGroupName: string
      recordingEnabled: boolean
  }
  status: string
  progressText: any
  progressRatio: any
  estimatedTimeToStartSeconds: number
  artifacts: any[]
  sharedAsset: any
  features: {
    storageGB: number
    numPlanCredits_permitted: number
    numPlanCredits_used: number
  }    
  error: {
    errorMessage: string
    reason: string
    message: string
    moderation_category: string
    tally_asimov: boolean
  }
  replyUrl: string
  replyRef: string
  code: number
}

Examples

curl -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer …" \
     -X POST "https://api.useapi.net/v1/runwayml/gen3/actone" \
     -d '{"driving_assetId": "…", "character_assetId": "…"}'

const driving_assetId = "video asset you want to use to drive performance";      
const character_assetId = "image or video asset for your character reference";      
const apiUrl = `https://api.useapi.net/v1/runwayml/gen3/actone`; 
const token = "API token";
const data = { 
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json' }
};
data.body = JSON.stringify({ 
  driving_assetId, character_assetId
});
const response = await fetch(apiUrl, data);
const result = await response.json();
console.log("response", {response, result});

import requests
driving_assetId = "video asset you want to use to drive performance"
character_assetId = "image or video asset for your character reference"
apiUrl = f"https://api.useapi.net/v1/runwayml/gen3/actone" 
token = "API token"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
body = {
    "driving_assetId": f"{driving_assetId}",
    "character_assetId": f"{character_assetId}"
}
response = requests.post(apiUrl, headers=headers, json=body)
print(response, response.json())