Getting Started

Installation

Install the Scrptly package from npm:

npm install scrptly
# or using yarn
yarn add scrptly

Authentication

Before you can interact with the Scrptly API, you need to configure your API key. Call Scrptly.setApiSettings() once at the top of your script:

import Scrptly from 'scrptly';

Scrptly.setApiSettings({
  apiKey: 'YOUR_API_KEY_HERE',        // ← Replace with your real key
});

You can get your API key from the Scrptly account page after signing up.
Make sure you guard your API key (e.g. via environment variables) and rotate it if it ever gets exposed.

Available APIs

Scrptly provides several APIs to interact with different services:

• AI Video-Agent API: Create entire videos using natural language prompts.
• MCP API: Connect Scrptly with your prefered LLM via the MCP interface
• N8N Integration: Create long-form ai videos in N8N workflows using Scrptly's AI Video-Agent.
• Video Development Kit API: Programmatically create and customize videos using code.