# Rendley Docs

> The AI video editor that plugs into Claude, Codex, and any MCP client. Use Rendley from your AI chat, your backend, or your own product.

## MCP
- [Overview](https://docs.rendley.com/mcp/getting-started/): Connect Rendley to your AI client over MCP. Choose the public connector for guided planning or the automation connector for fully unattended video creation.
- [Authentication](https://docs.rendley.com/mcp/authentication/): Sign in with Rendley, or connect with a Rendley API key.
- [Connect Claude](https://docs.rendley.com/mcp/claude/): Add Rendley to Claude on desktop, web, or Claude Code.
- [Connect ChatGPT](https://docs.rendley.com/mcp/chatgpt/): Add Rendley to ChatGPT as a custom connector over OAuth, or to the OpenAI Codex app and CLI.
- [Other clients](https://docs.rendley.com/mcp/other-clients/): Connect any remote-MCP client to Rendley with the endpoint, your credentials, and a config block.
- [API access](https://docs.rendley.com/mcp/api-access/): Call the Rendley agent over plain HTTP from your own backend, with no MCP client.
- [Troubleshooting](https://docs.rendley.com/mcp/troubleshooting/): Common errors when connecting Rendley to an MCP client, and how to fix them.
- [Automation connector](https://docs.rendley.com/mcp/automation/): Use Rendley's full-access MCP endpoint for unattended video creation, headless editing, and automated export.

## API
- [Getting started](https://docs.rendley.com/api/getting-started/): Drive the Rendley video editor from your backend over REST. Prompt for a video, run AI tools, and get a finished MP4 back.
- [Automated video editing](https://docs.rendley.com/api/automated-editing/): Send a prompt to the Rendley agent and let it edit your video. Export when you're ready.
- [Authentication](https://docs.rendley.com/api/authentication/): How to authenticate requests to the Rendley API.
- [Jobs and polling](https://docs.rendley.com/api/jobs-and-polling/): How long-running work runs as jobs, and how to poll a job to completion.
- [Render a video](https://docs.rendley.com/api/render-a-video/): Create a project from a template and render it to a downloadable file.
- [Streaming agent sessions](https://docs.rendley.com/api/prompt-to-video/): Use SSE streaming for real-time agent responses and interactive control over the editing process.

## SDK
- [Introduction](https://docs.rendley.com/sdk/introduction/): Rendley SDK is a framework for building browser-based video editing apps — compositions, effects, transitions, captions, and client or server rendering.
- [Concepts](https://docs.rendley.com/sdk/concepts/): A high-level map of how the SDK fits together, familiar if you've worked with non-linear video editors before.
- [Best practices](https://docs.rendley.com/sdk/best-practices/): Optimize Rendley SDK performance — manage memory, speed up rendering, and keep in-browser video editing smooth in production apps.
- [Troubleshooting](https://docs.rendley.com/sdk/troubleshooting/): Common problems and how to fix them. If your issue isn't listed, open one on GitHub.
- [FAQ](https://docs.rendley.com/sdk/faq/): Short answers to questions that come up often. For hands-on guides, see the Getting Started pages.
- [Roadmap](https://docs.rendley.com/sdk/roadmap/): Planned and completed improvements for the Rendley SDK, grouped by priority.
- [Changelog](https://docs.rendley.com/sdk/changelog/): Release notes and version history for the Rendley SDK, newest releases first.
- [Installation](https://docs.rendley.com/sdk/quick-start/installation/): Rendley SDK can be installed via npm, yarn, or pnpm.
- [Create your first video](https://docs.rendley.com/sdk/quick-start/create-first-video/): The minimum code to render something on screen — initialize the Engine, upload an image, add it to the timeline, and play.
- [Engine](https://docs.rendley.com/sdk/getting-started/engine/): The Engine is the main entry point for the SDK, a singleton that ensures only one instance exists at any given time.
- [Display](https://docs.rendley.com/sdk/getting-started/display/): The Display represents the WebGL canvas where the SDK renders every frame, configured through the Engine.init display option.
- [Library](https://docs.rendley.com/sdk/getting-started/library/): The Library is where uploaded assets such as media, filters, effects, transitions, and subtitles are stored and managed.
- [Fonts](https://docs.rendley.com/sdk/getting-started/fonts/): The SDK supports displaying custom fonts and different styles on the canvas, giving you complete control over the typography in your projects.
- [Timeline](https://docs.rendley.com/sdk/getting-started/timeline/): The Timeline drives the composition. It owns all layers and clips, controls playback, and tracks the current frame.
- [Layer](https://docs.rendley.com/sdk/getting-started/layer/): The Layer is where all clips and transitions are placed. Each layer is stacked on top of each other, enabling overlapping compositions.
- [Clips](https://docs.rendley.com/sdk/getting-started/clips/): A clip is the smallest unit of a composition. Every clip lives on a layer on the timeline and exposes a common API for timing, effects, and more.
- [Styling](https://docs.rendley.com/sdk/getting-started/styling/): Every clip that contains a sprite exposes its visual state through the style property, an instance of ClipStyle.
- [Crop & Zoom](https://docs.rendley.com/sdk/getting-started/crop/): The Crop API masks the visible area of a media clip. Cropping is non-destructive and can be animated through the Property Animator.
- [Playback Speed & Fades](https://docs.rendley.com/sdk/getting-started/playback-speed/): Video, audio, GIF, and Lottie clips can be slowed down or sped up. Video and audio clips additionally support pitch preservation and volume fades.
- [Subtitles / Captions](https://docs.rendley.com/sdk/getting-started/subtitles/): The Subtitles clip is responsible for displaying and syncing subtitles or captions with your video content.
- [Filters](https://docs.rendley.com/sdk/getting-started/filters/): Our filters use Lookup Tables (LUTs), offering precise control over the color grading process.
- [Effects](https://docs.rendley.com/sdk/getting-started/effects/): With WebGL, we can use GLSL shaders to create advanced effects that are computed directly on the GPU, ensuring high performance.
- [Transitions](https://docs.rendley.com/sdk/getting-started/transitions/): Using WebGL, we can create advanced transitions using GLSL shaders that are computed directly on the GPU, ensuring high performance.
- [Animation](https://docs.rendley.com/sdk/getting-started/animation/): Rendley SDK has two animation systems. Pick based on the job.
- [Keyframe Animation](https://docs.rendley.com/sdk/getting-started/property-animator/): The PropertyAnimator is the keyframe-based animation system introduced in 1.15.0.
- [Animation Controller](https://docs.rendley.com/sdk/getting-started/animation-layered/): Every clip exposes an AnimationController through clip.animationController.
- [Masking](https://docs.rendley.com/sdk/getting-started/masking/): Mask any clip in the Rendley SDK by using another clip as its alpha mask — shapes, text, images, or video — to control exactly what shows through.
- [Filmstrip & Waveforms](https://docs.rendley.com/sdk/getting-started/filmstrip/): The SDK can extract filmstrip frames and audio samples from each media entry in the Library.
- [Undo / Redo](https://docs.rendley.com/sdk/getting-started/undo-redo/): The SDK ships with an UndoManager that records state changes across the Engine, Timeline, Layers, Clips, Library, and Subtitles.
- [Storage](https://docs.rendley.com/sdk/getting-started/storage/): By default, the SDK does not upload your assets anywhere, files are kept in memory and will disappear after a page refresh.
- [Save / Restore Project](https://docs.rendley.com/sdk/getting-started/save-restore/): The SDK supports serialization and deserialization, enabling you to store the composition in a database and retrieve it later.
- [Export video](https://docs.rendley.com/sdk/getting-started/export/): The Rendley SDK allows you to export the final video using both client-side and server-side approaches.
- [Settings](https://docs.rendley.com/sdk/getting-started/settings/): Global configuration for the SDK, encoder, decoder, render loop, media processing, subtitles, and canvas behavior.
- [FFmpeg](https://docs.rendley.com/sdk/getting-started/ffmpeg/): The SDK bundles an FFmpeg WASM build for probing, transcoding, and audio mixing during export.
- [Zip Archive](https://docs.rendley.com/sdk/getting-started/zip-archive/): The ZipArchive utility builds and reads .zip files inside the SDK's FFmpeg virtual filesystem.
- [Video](https://docs.rendley.com/sdk/getting-started/clips/video/): The VideoClip loads a video file and renders it on the canvas. It supports trimming, freeze frames, playback speed, and audio extraction.
- [Audio](https://docs.rendley.com/sdk/getting-started/clips/audio/): The AudioClip plays an audio file on the timeline. It supports trimming, playback speed, pitch preservation, and volume fades.
- [Image](https://docs.rendley.com/sdk/getting-started/clips/image/): The ImageClip renders a static image on the canvas. Use it for photos, logos, or any non-animated visual asset.
- [GIF](https://docs.rendley.com/sdk/getting-started/clips/gif/): The GifClip renders animated GIFs and is the go-to choice for stickers and other animated visual elements that need transparency.
- [SVG](https://docs.rendley.com/sdk/getting-started/clips/svg/): The SvgClip renders vector graphics on the canvas. Ideal for logos, icons, and any asset that needs to stay sharp at any resolution.
- [Text](https://docs.rendley.com/sdk/getting-started/clips/text/): The TextClip renders text directly on the canvas. It supports font selection, color, stroke, drop shadow, letter spacing, line height, and more.
- [HTML Text](https://docs.rendley.com/sdk/getting-started/clips/html-text/): The HtmlTextClip renders a snippet of HTML as a visual element on the canvas. Useful for mixed styles, nested elements, or inline formatting.
- [Shape](https://docs.rendley.com/sdk/getting-started/clips/shape/): The ShapeClip draws vector shapes directly on the canvas. Prefer it over image assets for anything geometric.
- [Lottie](https://docs.rendley.com/sdk/getting-started/clips/lottie/): The LottieClip loads an Adobe After Effects composition (via Lottie/Bodymovin JSON) and renders it on the canvas.
- [Subtitles](https://docs.rendley.com/sdk/getting-started/clips/subtitles/): The SubtitlesClip renders time-synced captions on the canvas. It pulls its text from a Subtitles object stored in the Library.
- [Adjustment](https://docs.rendley.com/sdk/getting-started/clips/adjustment/): An Adjustment clip does not render visual content itself. The effects and filters attached to it apply to everything rendered below it.
- [Placeholder](https://docs.rendley.com/sdk/getting-started/clips/placeholder/): A Placeholder clip occupies a slot on the timeline while its media is still loading, then is replaced by the real clip in place.
- [Custom](https://docs.rendley.com/sdk/getting-started/clips/custom/): CustomClip is the base class you extend to add your own clip types, inheriting timing, trimming, transforms, animations, and serialization.
- [Rendering on device](https://docs.rendley.com/sdk/rendering/render-on-device/): Render video on-device using the CPU and GPU, cutting costs by avoiding the need to send all the composition assets.
- [Rendering on server](https://docs.rendley.com/sdk/rendering/render-on-server/): The server rendering approach uses the same SDK in a controlled environment with greater control over the rendering process and resources.
- [Listening to events](https://docs.rendley.com/sdk/user-interface/listening-to-events/): Interact with the SDK state by listening to events emitted in response to SDK actions, then react to changes in your app.
- [Overview](https://docs.rendley.com/sdk/video-editor-ui/overview/): A complete video editor interface built on top of the Rendley SDK, shipped as a single web component.
- [Installation](https://docs.rendley.com/sdk/video-editor-ui/installation/): The Video Editor UI is published as a web component, so you can drop it into any page regardless of framework.
- [Configuration](https://docs.rendley.com/sdk/video-editor-ui/configuration/): The Video Editor UI accepts configuration through HTML attributes and an inline JSON config block for structural options.
- [Events & Methods](https://docs.rendley.com/sdk/video-editor-ui/events-and-methods/): The rendley-video-editor element emits lifecycle events and exposes methods for reaching into the underlying Rendley SDK.
- [Common Tasks](https://docs.rendley.com/sdk/video-editor-ui/common-tasks/): Practical recipes for common Video Editor UI integration work, from saving projects to triggering exports and reacting to user actions.
- [Roadmap](https://docs.rendley.com/sdk/video-editor-ui/roadmap/): The Video Editor UI roadmap of planned and implemented features, organized by priority.
- [Changelog](https://docs.rendley.com/sdk/video-editor-ui/changelog/): Release notes and version history for the Rendley Video Editor UI web component.
- [Source Code ✨](https://docs.rendley.com/sdk/video-editor-ui/source-code/): Purchasing the source code lets you modify the Video Editor, remove the Rendley logo, integrate third-party services, and self-host it.
- [Slideshow Video](https://docs.rendley.com/sdk/examples/slideshow-video/): This section presents an example of creating a slideshow video from scratch.
- [Background Removal](https://docs.rendley.com/sdk/examples/background-removal/): An example application that integrates a WebGL fragment shader to perform background removal using chroma keying.

## Optional
- [API reference](https://docs.rendley.com/sdk/api-reference/index.html): Full generated TypeScript API reference for @rendley/sdk.