> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Overview
> Use AI to automatically enhance and stylize your videos with professional editing templates.
**Deprecated:** AI Editing API is deprecated and will be removed in a future release. Please use [URL to Video](/api-documentation/url-to-video/link-to-video) or [Custom Templates](/api-reference/custom-templates) instead.
## 🚀 Introduction
The **AI Editing API** allows you to upload a raw video and apply cinematic editing styles automatically. It's perfect for turning user-generated or brand footage into share-worthy content with minimal effort.
Whether you're creating marketing reels, tutorials, or social posts — our API applies consistent, high-quality editing based on your selected `editing_style`.
***
## ⚙️ Quickstart Guide
### ✅ Prerequisites
Before you begin, ensure you have:
* A [Creatify](https://app.creatify.ai) account with **API access**
* Your **API credentials** (see [Quickstart](/quickstart))
***
## 📝 Step 1: Submit a Video Editing Request
Use this endpoint to initiate AI-based editing on your video.
```bash Example Request theme={null}
curl --request POST \
--url https://api.creatify.ai/api/ai_editing/ \
--header 'Content-Type: application/json' \
--header 'X-API-ID: your-api-id' \
--header 'X-API-KEY: your-api-key' \
--data '{
"video_url": "https://d35ghwdno3nak3.cloudfront.net/media_file/2/20240805/038a9606-7b03-4fdd-a44d-122195a97afb_jun-16x9.mp4",
"editing_style": "film"
}'
```
```json Example Response theme={null}
{
"id": "7b8212dc-13ac-4719-948b-9ca1bc47f0e3",
"media_job": null,
"status": "pending",
"video_output": null,
"preview": null,
"credits_used": 0,
"is_hidden": false,
"progress": 0,
"created_at": "2025-05-21T22:52:36.132791-07:00",
"updated_at": "2025-05-21T22:52:36.132813-07:00",
"permission_type": "workspace",
"name": "Viral cut",
"script": "Imagine a day where every task feels effortless. Your home adjusts to your needs before you even ask. That's the promise of our smart home devices. Upgrade your living with the latest in technology, where convenience meets innovation. Discover gadgets that don't just simplify, but transform your daily routines. From sunrise to sunset, let your home do the work. It's not just smart, it's future ready. Explore our collection today and step into the home of tomorrow.",
"aspect_ratio": "16x9",
"is_talking_video": true,
"is_one_person_in_video": true,
"editing_style": "film",
"duration": 25.92,
"audio_url": "https://d35ghwdno3nak3.cloudfront.net/ai_viral_cut/audio_files/a62c947c_output.wav",
"video_url": "https://d35ghwdno3nak3.cloudfront.net/ai_viral_cut/temp_videos/37a4d253.mp4",
"size": 0.0,
"created_from_api": true,
"caption_setting": null,
"background_music_url": null,
"background_music_volume": null,
"voiceover_volume": null,
"webhook_url": null,
"user": 18165,
"workspace": "a1240918-1f02-47f1-bebe-832a555507f3"
}
```
> 🎬 The response includes a unique video ID. Save it to check status.
***
## ⏳ Step 2: Check Editing Status
Once submitted, your video will be processed asynchronously. Use the task ID to track progress and retrieve the final output.
```bash Example Request theme={null}
curl --request GET \
--url https://api.creatify.ai/api/ai_editing/7b8212dc-13ac-4719-948b-9ca1bc47f0e3/ \
--header 'X-API-ID: your-api-id' \
--header 'X-API-KEY: your-api-key'
```
```json Example Response theme={null}
{
"id": "7b8212dc-13ac-4719-948b-9ca1bc47f0e3",
"media_job": "2caa4cd5-d071-4ee7-89c7-84bd64a32f9a",
"status": "done",
"video_output": "https://s3.us-west-2.amazonaws.com/remotionlambda-uswest2-30tewi8y5c/renders/g68go892x3/output.mp4",
"preview": "https://app.creatify.ai/preview?layout=videos/20250521/34a6ddd3-7651-4982-ba97-2fa15a8cc466.json",
"credits_used": 5,
"is_hidden": false,
"progress": 1,
"created_at": "2025-05-21T22:52:36.132791-07:00",
"updated_at": "2025-05-21T22:52:36.269271-07:00",
"permission_type": "workspace",
"name": "Viral cut",
"script": "Imagine a day where every task feels effortless. Your home adjusts to your needs before you even ask. That's the promise of our smart home devices. Upgrade your living with the latest in technology, where convenience meets innovation. Discover gadgets that don't just simplify, but transform your daily routines. From sunrise to sunset, let your home do the work. It's not just smart, it's future ready. Explore our collection today and step into the home of tomorrow.",
"aspect_ratio": "16x9",
"is_talking_video": true,
"is_one_person_in_video": true,
"editing_style": "film",
"duration": 25.92,
"audio_url": "https://d35ghwdno3nak3.cloudfront.net/ai_viral_cut/audio_files/a62c947c_output.wav",
"video_url": "https://d35ghwdno3nak3.cloudfront.net/ai_viral_cut/temp_videos/37a4d253.mp4",
"size": 0.0,
"created_from_api": true,
"caption_setting": null,
"background_music_url": null,
"background_music_volume": null,
"voiceover_volume": null,
"webhook_url": null,
"user": 18165,
"workspace": "a1240918-1f02-47f1-bebe-832a555507f3"
}
```
> ⏳ Once `status` is `done`, retrieve your final edited video from the `video_output` field.
***
## 🎯 Summary
| Step | Endpoint |
| ------------- | ----------------------------------------------------------------- |
| Create Task | `POST /api/ai_editing/` |
| Check Status | `GET /api/ai_editing/{id}/` |
| API Reference | [AI Editing Reference](/api-reference/ai-editing/post-ai-editing) |
***
## 🤝 Need Help?
If you run into any issues, check out our [API Reference](/api-reference) or contact [api@creatify.ai](mailto:api@creatify.ai).