# generate-social-video-script

> Generate viral short-form video scripts for social media based on a topic and niche.

## Overview

- **Endpoint**: `POST https://api.muapi.ai/api/v1/generate-social-video-script`
- **Model ID**: `generate-social-video-script`
- **Category**: text to text
- **Variant**: AI Script Engine
- **Family**: text-generation
- **Cost**: 0.1 credits per call (some models compute cost dynamically based on params)

## API Usage

MuApi uses a **submit-then-poll** pattern: submit a job, get a `request_id`, then poll the predictions endpoint until `status` is `completed`. Optionally pass `?webhook=YOUR_URL` on the submit call to receive a POST callback when the job finishes (skip polling).

**Authentication**: send your MuApi key in the `x-api-key` header. Get one at https://muapi.ai/access-keys.

### 1. Submit a job

```http
POST https://api.muapi.ai/api/v1/generate-social-video-script
Content-Type: application/json
x-api-key: YOUR_API_KEY
```

**Minimum (required only):**

```json
{
  "title": "<title>"
}
```

**Full example (all params):**

```json
{
  "title": "<title>",
  "niche": "Tech & Coding",
  "platform": "tiktok",
  "duration": 30,
  "reference_hook": "<reference_hook>"
}
```

**Response:**

```json
{
  "request_id": "abc123",
  "status": "processing"
}
```

### 2. Poll for the result

```http
GET https://api.muapi.ai/api/v1/predictions/{request_id}/result
x-api-key: YOUR_API_KEY
```

Possible `status` values: `queued`, `pending`, `processing`, `completed`, `failed`, `cancelled`. Poll every 2-5 seconds until terminal. When `completed`, the result URLs are in the `outputs` array.

**Example response when `completed`:**

```json
{
  "id": "abc123",
  "status": "completed",
  "outputs": [
    "https://cdn.muapi.ai/.../output.png"
  ],
  "urls": {
    "get": "https://api.muapi.ai/api/v1/predictions/abc123/result"
  },
  "created_at": "2026-05-08T12:34:56Z",
  "has_nsfw_contents": []
}
```

### cURL

```bash
# 1. Submit
REQUEST_ID=$(curl -s -X POST https://api.muapi.ai/api/v1/generate-social-video-script \
  -H "x-api-key: $MUAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"<title>"}' | jq -r .request_id)

# 2. Poll until completed
while :; do
  RESP=$(curl -s https://api.muapi.ai/api/v1/predictions/$REQUEST_ID/result -H "x-api-key: $MUAPI_API_KEY")
  STATUS=$(echo "$RESP" | jq -r .status)
  [ "$STATUS" = "completed" ] && echo "$RESP" | jq .outputs && break
  [ "$STATUS" = "failed" ] && echo "$RESP" && exit 1
  sleep 3
done
```

### Python

```python
import os, time, requests

API = "https://api.muapi.ai/api/v1"
headers = {"x-api-key": os.environ["MUAPI_API_KEY"]}

r = requests.post(f"{API}/generate-social-video-script", headers=headers, json={"title":"<title>"})
request_id = r.json()["request_id"]

while True:
    res = requests.get(f"{API}/predictions/{request_id}/result", headers=headers).json()
    if res["status"] == "completed":
        print(res["outputs"]); break
    if res["status"] == "failed":
        raise RuntimeError(res.get("error")); 
    time.sleep(3)
```

## Input Schema

The API accepts the following input parameters:

- **`title`** (`text`, _required_):
  The topic or subject of the script.

- **`niche`** (`string`, _optional_):
  Content niche.
  - Default: `"Tech & Coding"`
  - Options: `"Tech & Coding"`, `"Marketing & SaaS"`, `"Self-Development & Mindset"`, `"General Lifestyle"`

- **`platform`** (`string`, _optional_):
  Target social media platform.
  - Default: `"tiktok"`
  - Options: `"tiktok"`, `"instagram"`, `"youtube"`, `"twitter"`, `"facebook"`

- **`duration`** (`int`, _optional_):
  Script duration in seconds (15, 30, or 60).
  - Default: `30`
  - Range: `15` to `60`

- **`reference_hook`** (`string`, _optional_):
  An optional viral hook to base the opening script on.

## Output Schema

The polling endpoint returns the following fields:

- **`id`** (`string`): The request ID.
- **`status`** (`string`): One of `queued`, `pending`, `processing`, `completed`, `failed`, `cancelled`.
- **`outputs`** (`array`): URLs to generated images/videos/audio. Empty until `status` is `completed`.
- **`urls.get`** (`string`): Self-link to re-fetch this prediction.
- **`error`** (`string` | `null`): Error message if `status` is `failed`.
- **`created_at`** (`string`): ISO-8601 timestamp of when the request was created.
- **`has_nsfw_contents`** (`array of boolean`): Per-output NSFW detection flags.

## Webhooks (optional)

Append `?webhook=https://your-server/path` to the submit URL. When the job reaches a terminal state, MuApi will POST the same shape as the polling response to your URL — no polling needed.

## Agent Integration

MuApi ships an MCP server and CLI so agents (Claude Code, Cursor, custom) can call this endpoint without writing HTTP code:

```bash
# Install the CLI
npm install -g muapi-cli

# Authenticate once
muapi auth login

# Expose all MuApi models as MCP tools to your agent
muapi mcp serve
```

The MCP server exposes tools that wrap submit + poll for every model, including `generate-social-video-script`. See `muapi --help` for category-specific shortcuts (`muapi image generate`, `muapi video from-image`, etc.).

## Related Models
- [Claude Sonnet 4.6](https://muapi.ai/playground/claude-sonnet-4-6)
- [GPT5 Nano Text](https://muapi.ai/playground/gpt-5-nano)
- [Gemini 3.7 Flash (OpenAI)](https://muapi.ai/playground/gemini-3-7-flash-openai)
- [Claude Opus 4.6](https://muapi.ai/playground/claude-opus-4-6)
- [GPT Codex](https://muapi.ai/playground/gpt-codex)
- [Claude Opus 4.8](https://muapi.ai/playground/claude-opus-4-8)
- [Gemini 3.5 Flash](https://muapi.ai/playground/gemini-3-5-flash)
- [Gemini 3.5 Flash (OpenAI)](https://muapi.ai/playground/gemini-3-5-flash-openai)
- [Claude Opus 4.7](https://muapi.ai/playground/claude-opus-4-7)
- [Gemini 3.1 Pro](https://muapi.ai/playground/gemini-3-1-pro)
- [Gemini 3 Pro](https://muapi.ai/playground/gemini-3-pro)
- [Claude Opus 4.5](https://muapi.ai/playground/claude-opus-4-5)
- [Claude Sonnet 4.5](https://muapi.ai/playground/claude-sonnet-4-5)
- [Claude Haiku 4.5](https://muapi.ai/playground/claude-haiku-4-5)
- [GPT 5.2](https://muapi.ai/playground/gpt-5-2)
- [Gemini 2.5 Pro](https://muapi.ai/playground/gemini-2-5-pro)
- [Gemini 2.5 Flash](https://muapi.ai/playground/gemini-2-5-flash)
- [GPT 5.5](https://muapi.ai/playground/gpt-5-5)
- [Claude Fable 5](https://muapi.ai/playground/claude-fable-5)
- [AI Script Engine](https://muapi.ai/playground/generate-social-video-script)
- [GPT 5.6 Luna](https://muapi.ai/playground/gpt-5-6-luna)
- [Claude Sonnet 5](https://muapi.ai/playground/claude-sonnet-5)
- [Grok 4.3](https://muapi.ai/playground/grok-4-3)
- [Grok 4.5](https://muapi.ai/playground/grok-4-5)
- [GPT 5.6 Terra](https://muapi.ai/playground/gpt-5-6-terra)
- [GPT 5.6 Sol](https://muapi.ai/playground/gpt-5-6-sol)
- [Gemini 3.6 Flash](https://muapi.ai/playground/gemini-3-6-flash)
- [Gemini 3.6 Flash (OpenAI)](https://muapi.ai/playground/gemini-3-6-flash-openai)
- [Grok 4.7](https://muapi.ai/playground/grok-4-7)
- [Claude Opus 5](https://muapi.ai/playground/claude-opus-5)
- [Grok 4.6](https://muapi.ai/playground/grok-4-6)
- [GPT5 Mini Text](https://muapi.ai/playground/gpt-5-mini)
- [Kimi K3](https://muapi.ai/playground/kimi-k3)
- [Gemini 3 Flash](https://muapi.ai/playground/gemini-3-flash)
- [DeepSeek V4 Flash](https://muapi.ai/playground/deepseek-v4-flash)
- [DeepSeek V4 Pro](https://muapi.ai/playground/deepseek-v4-pro)
- [GPT-5.4](https://muapi.ai/playground/gpt-5-4)
- [Gemini 3.7 Flash](https://muapi.ai/playground/gemini-3-7-flash)

## Resources
- [Playground Page](https://muapi.ai/playground/generate-social-video-script)
- [API Reference](https://muapi.ai/playground/generate-social-video-script?tab=2)
- [Global llms.txt](https://muapi.ai/llms.txt)