Skip to content

Quickstart

In this tutorial, we will build a React web app that video calls a Runway character — in under 5 minutes.

Helpful links:

Create an account at dev.runwayml.com.

Dev portal login page

Once you log in, you will see an “Characters” tab at the top bar, and there are a few preset characters. We are going to video call the character called “Tooth”.

Characters tab showing Mina character

Go to the Manage tab in the top bar, then click the New API key button in the top-right corner.

Manage tab with New API key button

Give your key a name and copy it to a safe location. Once you close the pop-up, the key value is not available again. You can always create a new key if needed.

API key name input

API key copy dialog

Click on Billing in the left sidebar under the Manage tab, and add some credits to the account.

Billing page

Adding credits

In your terminal, run this command to copy the template into your local directory:

Terminal window
npx degit runwayml/avatars-sdk-react/examples/nextjs-simple my-avatar-app
cd my-avatar-app

Make sure you are using Node.js 18+, then install dependencies:

Terminal window
npm install

Copy the .env.example file as .env, and paste your API key:

RUNWAYML_API_SECRET=your_api_key_here
Terminal window
npm run dev

The server starts at http://localhost:3000. Click on the Mina character to start a conversation.

Character selection screen

Active video call

  • API key errors:
    • Make sure you copy the entire API key correctly. The key begins with key_ followed by 128 hex characters.
    • Make sure the key is currently active. Deactivated keys will be rejected.
  • No credits: Make sure the developer account has credits before starting a call.