---
title: "Plan an AI shot"
method: POST
path: "/v1/ai-media/shot"
tags: ["Studio"]
---

# Plan an AI shot

`POST /v1/ai-media/shot`

## Request

- Base URL: `https://api.vidocu.ai`
- URL: `https://api.vidocu.ai/v1/ai-media/shot`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://vidocu.ai/oauth/authorize`, token URL `https://api.vidocu.ai/oauth/token`)

Turns a description (and the narration it plays under) into an editable shot, plus warnings for what AI video does badly: readable text, logos, software screens, real people, exact steps. Free.

**Scope:** `studio:write`

**Role permission:** `canCreate` (OAuth only — API keys carry full workspace permissions)

## Request body

- object
  - `description` string: What the shot should show
  - `narration` string: The narration the shot plays under
  - `preset` 'documentary' | 'studio' | 'onSite' | 'cinematic' | 'isometric3d' | 'flat2d' | 'cartoon3d' | 'storybook' | 'claymation' | 'whiteboard' | 'classroom' | 'brand': Visual style. Default documentary
  - `styleNote` string: Your own style words on top of the preset
  - `current` object: Refine: the shot as it is now
    - `subject` string
    - `action` string
    - `setting` string
    - `framing` string
    - `camera` string
    - `lighting` string
  - `change` string: Refine: the change to make, e.g. "darker, closer"

## Response `200`

Success

## Other responses

- `400`: Validation error
- `401`: Invalid or missing credentials
- `403`: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
- `429`: Rate limit exceeded (60 req/min)
- `500`: Server error

---

[API](https://skmtc.dev/vidocu/apis/vidocu-api.md) · [All operations](https://skmtc.dev/vidocu/apis/vidocu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidocu/apis/vidocu-api/revisions/cc813d2ca5d2?raw)