> ## Documentation Index
> Fetch the complete documentation index at: https://docs.framelane.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Framelane is a developer API for GPU-accelerated video rendering and AI media processing.

## What is Framelane?

Framelane exposes your video production pipeline as a REST API. Submit a composition, get back a rendered video. Run AI processing tasks — transcription, translation, background removal, super-resolution, and more — as simple async jobs.

Every operation follows the same pattern:

```
Upload or import media (if needed)  →  Submit job  →  Wait  →  Download artifact
```

**Wait** using either:

* **Polling** — `GET /v1/renders/{id}` or `GET /v1/tasks/{id}` until `status` is `completed` or `failed`
* **Webhooks** — subscribe to `render.completed` / `task.completed` (recommended for production)

Bring media into Framelane storage when needed:

* **Local file** — [`POST /v1/uploads`](/introduction/uploads)
* **Remote URL you don't control** (public link or cloud share link) — set [`ingest_external: true`](/introduction/uploads#importing-public-urls) on the render and pass the URL as an element `source_url`; Framelane copies it into your workspace first
* **Your own CDN** — pass the URL directly as `source_url` (no upload or copy)

The Framelane Renderer is a GPU-accelerated Rust/wgpu compositor — not FFmpeg. This enables real-time compositing, hardware encoding, and sub-realtime render times for complex compositions.

## Key Concepts

<CardGroup cols={2}>
  <Card title="Renders" icon="film" href="/renders/overview">
    Compose and render video from a timeline of elements — video clips, images, text overlays, audio tracks, and transitions.
  </Card>

  <Card title="Preview" icon="eye" href="/renders/preview">
    Validate a composition for free, or render a cheap frame, clip, or whole-timeline contact sheet before spending a full render.
  </Card>

  <Card title="Tasks" icon="bolt" href="/tasks/overview">
    AI operations: remove background, gaze redirect, super resolution, and transcribe.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks/overview">
    Subscribe to job lifecycle events. HMAC-signed payloads with a 7-attempt retry schedule and dead-letter queue.
  </Card>

  <Card title="Agent Skills" icon="robot" href="/agent-skills/overview">
    Loadable playbooks for common agent workflows — composable, tested, ready to use in any MCP-capable agent framework.
  </Card>

  <Card title="Playground" icon="play" href="/renders/playground">
    Build a composition and preview it in the browser with WebGPU — the same renderer as the API — then copy the exact render request.
  </Card>
</CardGroup>

## API Base URL

```
https://api.framelane.io
```

All endpoints use HTTPS. All request and response bodies are JSON.