# P Video Avatar API Documentation

> LLM-optimized documentation for P Video Avatar. Copy into your AI assistant for integration help.

## Overview

**Model ID:** `p-video-avatar`
**Type:** Video Generation
**Credit Cost:** 1 credits per second (per-second by resolution: 720p: 1, 1080p: 2)

Pruna P Video Avatar — animate a portrait into a talking avatar from a script or an audio file. 30 voices, 10 languages, 720p / 1080p.

## Endpoint

```
POST https://pixeldojo.ai/api/v1/models/p-video-avatar/run
```

## Authentication

All requests require an API key in the Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```

Get your API key: https://pixeldojo.ai/api-platform/api-keys

## Input Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `image` | url | Yes | - | URL of a portrait image to animate (jpg, jpeg, png, webp). |
| `voice_script` | string | No | - | Text the avatar should speak. Required unless `audio` is provided. |
| `audio` | url | No | - | Optional audio file for lip-sync. When provided, overrides voice_script and voice. |
| `voice` | enum | No | Zephyr (Female) | Named voice to synthesize the script with. Ignored when audio is provided. (Options: Zephyr (Female), Puck (Male), Charon (Male), Kore (Female), Fenrir (Male)...) |
| `voice_language` | enum | No | English (US) | Language for voice synthesis. (Options: English (US), English (UK), Spanish, French, German...) |
| `video_prompt` | string | No | - | Optional guidance for visual motion (e.g. "warm smile, slight nods"). |
| `voice_prompt` | string | No | - | Optional speaking-style cue (e.g. "Say the following with quiet confidence."). |
| `resolution` | enum | No | 720p | Output resolution. (Options: 720p, 1080p) |
| `disable_prompt_upsampling` | boolean | No | false | Skip the model's automatic prompt-enhancement pass. |
| `seed` | integer | No | - | Optional integer seed for reproducible output. |



## Capabilities

- Image to Video
- Audio Generation
- NSFW Content

## Quick Start

### 1. Submit a Job

```bash
curl -X POST "https://pixeldojo.ai/api/v1/models/p-video-avatar/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A cinematic shot of ocean waves crashing at golden hour, 4K quality",
    "aspect_ratio": "16:9",
    "duration": 5
  }'
```

**Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123",
  "creditCost": 5,
  "creditsRemaining": 95
}
```

### 2. Poll for Results

```bash
curl "https://pixeldojo.ai/api/v1/jobs/job_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Completed Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "completed",
  "output": {
    "video": "https://temp.pixeldojo.ai/..."
  },
  "creditCost": 5
}
```

## Python Example

```python
import requests
import time

API_KEY = "YOUR_API_KEY"

# Submit job
response = requests.post(
    "https://pixeldojo.ai/api/v1/models/p-video-avatar/run",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "prompt": "A cinematic shot of ocean waves crashing at golden hour, 4K quality",
        "aspect_ratio": "16:9",
        "duration": 5
    }
)

job = response.json()
job_id = job["jobId"]

# Poll for completion
while True:
    status_response = requests.get(
        f"https://pixeldojo.ai/api/v1/jobs/{'{job_id}'}",
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
    status = status_response.json()
    
    if status["status"] == "completed":
        print("Output:", status["output"])
        break
    elif status["status"] == "failed":
        print("Error:", status.get("error"))
        break
    
    time.sleep(2)
```

## JavaScript Example

```javascript
const API_KEY = 'YOUR_API_KEY';

// Submit job
const submitResponse = await fetch('https://pixeldojo.ai/api/v1/models/p-video-avatar/run', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: 'A cinematic shot of ocean waves crashing at golden hour, 4K quality',
    aspect_ratio: '16:9',
    duration: 5
  })
});

const job = await submitResponse.json();

// Poll for completion
const pollForResult = async (jobId) => {
  while (true) {
    const statusResponse = await fetch(`https://pixeldojo.ai/api/v1/jobs/${jobId}`, {
      headers: { 'Authorization': `Bearer ${API_KEY}` }
    });
    const status = await statusResponse.json();
    
    if (status.status === 'completed') return status.output;
    if (status.status === 'failed') throw new Error(status.error);
    
    await new Promise(r => setTimeout(r, 2000));
  }
};

const output = await pollForResult(job.jobId);
console.log('Output:', output);
```

## Error Codes

| Code | Status | Description |
|------|--------|-------------|
| `unauthorized` | 401 | Invalid or missing API key |
| `insufficient_credits` | 402 | Not enough credits |
| `invalid_request` | 400 | Invalid parameters |
| `model_not_found` | 404 | Model ID not found |
| `rate_limited` | 429 | Too many requests |
| `internal_error` | 500 | Server error |

## Links

- **Full Documentation:** https://pixeldojo.ai/api-platform/p-video-avatar
- **API Keys:** https://pixeldojo.ai/api-platform/api-keys
- **Buy Credits:** https://pixeldojo.ai/api-platform/buy-credits
- **All Models:** https://pixeldojo.ai/api/v1/models
- **OpenAPI Spec:** https://pixeldojo.ai/api/openapi