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

# Nouvel API

> Programmatic access to Nouvel

<Info>
  The Nouvel API is currently in **beta**. We're actively improving the platform and welcome your feedback.
</Info>

## Overview

Nouvel generates high-quality UGC-style video ads from product URLs using AI. The API allows you to automate video ad creation at scale, making it perfect for:

* **E-commerce platforms** creating product videos automatically
* **Marketing agencies** managing campaigns for multiple clients
* **Performance marketers** A/B testing creative at scale
* **Automation workflows** integrating video generation into your tools

Simply provide a product URL, and Nouvel will:

1. Scrape product information (images, descriptions, benefits)
2. Generate persuasive ad concepts with AI
3. Create 15-60 second UGC-style videos with professional actors
4. Add lip-synced voiceover and captions
5. Deliver production-ready video files

<CardGroup cols={2}>
  <Card icon="globe" title="Base URL">
    ```text theme={null}
    https://app.nouvel.ai
    ```
  </Card>

  <Card icon="code-branch" title="API Version">
    ```text theme={null}
    v1
    ```
  </Card>
</CardGroup>

## Key Features

<CardGroup cols={2}>
  <Card icon="wand-magic-sparkles" title="AI-Powered Generation">
    Transform product URLs into complete video ads in 2-5 minutes. Our AI analyzes your product, creates scripts, and generates videos with professional UGC actors.
  </Card>

  <Card icon="layer-group" title="Multi-Variant Testing">
    Generate 1-3 video variants per product URL in a single request. Perfect for creative testing and finding winning ads faster.
  </Card>

  <Card icon="share-nodes" title="Multi-Platform Publishing">
    Publish completed videos to Instagram, TikTok, YouTube, Facebook, LinkedIn, Pinterest, and more — directly from the API. Schedule posts for the future or publish immediately.
  </Card>

  <Card icon="chart-line" title="Analytics & Insights">
    Track post performance, follower growth, and daily engagement metrics across all connected social accounts.
  </Card>

  <Card icon="robot" title="AI Copilot">
    Get AI-powered help with ad strategy, caption writing, product research, and creative ideation via the Copilot chat endpoint.
  </Card>

  <Card icon="bell" title="Webhooks">
    Register webhook URLs to receive real-time notifications when video generation jobs complete — no polling required.
  </Card>
</CardGroup>

## Available Plans

API access is available on **Scale** and **Business** plans only.

<CardGroup cols={2}>
  <Card icon="rocket" title="Scale Plan">
    **\$249/month**

    * 30 videos per month
    * Up to 5 API keys
    * Team workspace (5 seats)
    * Custom avatars
    * All formats (9:16, 1:1, 16:9)
  </Card>

  <Card icon="building" title="Business Plan">
    **\$849/month**

    * 120 videos per month
    * Up to 5 API keys
    * Team workspace (20 seats)
    * Priority support
    * Dedicated account manager
  </Card>
</CardGroup>

<Info>
  Need API access? [Upgrade your plan](https://app.nouvel.ai/settings) to Scale or Business to unlock API keys.
</Info>

## Rate Limits

All API keys are subject to the following rate limits:

* **60 requests per minute** per API key
* Rate limit resets every 60 seconds
* Exceeding the limit returns a `429 Too Many Requests` response

<Tip>
  If you need higher rate limits for enterprise use cases, [contact our team](mailto:support@nouvel.ai) to discuss custom plans.
</Tip>

## Response Format

All API responses are JSON with consistent error handling:

```json theme={null}
{
  "error": "Error message",
  "details": "Optional additional context"
}
```

Successful responses vary by endpoint. See individual endpoint documentation for details.

## Common Error Codes

| Status Code | Meaning                                                              |
| ----------- | -------------------------------------------------------------------- |
| `400`       | Bad Request - Invalid parameters or malformed JSON                   |
| `401`       | Unauthorized - Invalid or missing API key                            |
| `402`       | Payment Required - Quota exceeded or plan upgrade needed             |
| `404`       | Not Found - Resource doesn't exist or doesn't belong to your account |
| `422`       | Unprocessable Entity - URL is not a valid product page               |
| `429`       | Too Many Requests - Rate limit exceeded                              |
| `500`       | Internal Server Error - Something went wrong on our end              |

## Next Steps

<CardGroup cols={3}>
  <Card icon="key" href="/api-reference/authentication" title="Authentication">
    Learn how to create and use API keys
  </Card>

  <Card icon="bolt" href="/api-reference/quickstart" title="Quickstart">
    Generate your first video in 5 minutes
  </Card>

  <Card icon="wand-magic-sparkles" href="/api-reference/generate" title="Generate">
    Generate video ads from product URLs
  </Card>

  <Card icon="share-nodes" href="/api-reference/publish" title="Publish">
    Publish videos to social platforms
  </Card>

  <Card icon="chart-line" href="/api-reference/analytics" title="Analytics">
    Track performance across platforms
  </Card>

  <Card icon="robot" href="/api-reference/copilot-chat" title="Copilot">
    AI-powered creative assistance
  </Card>
</CardGroup>