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

# Introduction

> Welcome to the Pictory API documentation. Learn how to integrate AI-powered video creation into your applications.

## Welcome to Pictory API

The Pictory API enables developers to integrate AI-powered video creation and editing capabilities directly into their applications. Build automated video workflows, create personalized video content at scale, and leverage Pictory's advanced features programmatically.

<Card title="Get Your API Key" icon="key" href="https://app.pictory.ai/api-access">
  Access your API key from the Pictory dashboard
</Card>

***

## What You Can Build

The Pictory API provides comprehensive access to create and manage video content:

<CardGroup cols={2}>
  <Card title="Storyboard" icon="video">
    Create storyboard preview or render storyboard video
  </Card>

  <Card title="Video Templates" icon="copy">
    Build reusable templates for consistent video production
  </Card>

  <Card title="Transcription & AI" icon="waveform">
    Generate transcripts and AI-powered video summaries
  </Card>

  <Card title="Branding & Styling" icon="palette">
    Apply custom fonts, styles, and brand configurations
  </Card>

  <Card title="Media Management" icon="images">
    Search and manage media assets for your videos
  </Card>

  <Card title="VoiceOvers & Music" icon="music">
    Add professional audio tracks and background music
  </Card>

  <Card title="Cloud Integrations" icon="cloud">
    Connect with AWS S3 and Vimeo for storage and hosting
  </Card>

  <Card title="Job Monitoring" icon="list-check">
    Track asynchronous processing tasks and results
  </Card>
</CardGroup>

***

## Quick Start

Get started with the Pictory API in three simple steps:

<Steps>
  <Step title="Get Your API Key">
    Sign up for a Pictory account and obtain your API key from the [API Access page](https://app.pictory.ai/api-access).

    Your API key will start with `pictai_` and must be kept secure.
  </Step>

  <Step title="Make Your First Request">
    Test your API key by fetching your projects:

    ```bash theme={null}
    curl --request GET \
      --url 'https://api.pictory.ai/pictoryapis/v2/projects' \
      --header 'Authorization: YOUR_API_KEY' \
      --header 'accept: application/json'
    ```
  </Step>

  <Step title="Create Your First Video">
    Create a text-to-video storyboard preview:

    ```bash theme={null}
    curl --request POST \
      --url 'https://api.pictory.ai/pictoryapis/v2/video/storyboard' \
      --header 'Authorization: YOUR_API_KEY' \
      --header 'Content-Type: application/json' \
      --data '{
        "videoName": "my_first_video",
        "scenes": [
          {
            "story": "Welcome to Pictory! This is your first AI-generated video. Turn any text into engaging video content in seconds.",
            "createSceneOnEndOfSentence": true
          }
        ]
      }'
    ```

    This returns a `jobId` that you can use to check the status and get the preview output.
  </Step>

  <Step title="Check Job Status">
    Poll the job status to get your video preview:

    ```bash theme={null}
    curl --request GET \
      --url 'https://api.pictory.ai/pictoryapis/v1/jobs/{jobId}' \
      --header 'Authorization: YOUR_API_KEY'
    ```

    When `status` is `completed`, you'll receive the preview output with scene thumbnails and renderParams.
  </Step>

  <Step title="Explore the API">
    Browse the API reference documentation to discover all available endpoints and capabilities.
  </Step>
</Steps>

***

## Base URL

All API endpoints use the following base URL:

```
https://api.pictory.ai/pictoryapis
```

<Warning>
  **Critical: Use the Correct API Version**

  Different endpoints use different API versions (`/v1/` or `/v2/`). Always verify you are using the correct version for each endpoint.
</Warning>

***

## Authentication

All API requests must be authenticated using your API key in the `Authorization` header.

### API Key Format

```
Authorization: pictai_your_api_key_here
```

<Warning>
  **Keep Your API Key Secure**: Never expose your API key in client-side code, public repositories, or unsecured locations. Use environment variables and secure secret management.
</Warning>

***

## Common Workflows

Explore these popular workflows to get started quickly:

<CardGroup cols={2}>
  <Card title="Text to Video with AI Voice-Over" icon="microphone" href="/guides/text-to-video/ai-voiceover">
    Turn text into engaging videos with natural-sounding AI narration
  </Card>

  <Card title="Blog URL to Video with AI Voice-Over" icon="newspaper" href="/guides/article-to-video/blog-with-voiceover">
    Transform blog articles into video content with AI voice narration
  </Card>

  <Card title="Podcast/Audio to Video" icon="headphones" href="/guides/audio-to-video/podcast-to-video">
    Convert podcast episodes and audio files into visual content
  </Card>

  <Card title="AI-Generated Visuals" icon="sparkles" href="/guides/ai-generated-visuals/background-images">
    Create videos with AI-generated images and visuals
  </Card>
</CardGroup>

***

<Tip>
  If you encounter rate limiting (HTTP 429), implement exponential backoff retry logic in your application.
</Tip>

***

## Best Practices

### Security

1. **Secure API Keys**: Store keys in environment variables or secret managers
2. **Rotate Keys**: Periodically rotate API keys for enhanced security

### Performance

1. **Cache Static Data**: Cache fonts, styles, and brands locally
2. **Batch Operations**: Group related API calls when possible

***

## Stay Connected

Join our community and stay updated with the latest features, tips, and announcements:

<CardGroup cols={4}>
  <Card title="X (Twitter)" icon="x-twitter" href="https://x.com/pictoryai">
    Get real-time updates, tips, and product announcements
  </Card>

  <Card title="LinkedIn" icon="linkedin" href="https://www.linkedin.com/company/pictory">
    Professional insights, company news, and industry trends
  </Card>

  <Card title="Instagram" icon="instagram" href="https://www.instagram.com/pictoryai/">
    Visual inspiration, video tips, and creative content
  </Card>

  <Card title="YouTube" icon="youtube" href="https://www.youtube.com/@Pictory">
    Video tutorials, feature demos, and how-to guides
  </Card>

  <Card title="Facebook" icon="facebook" href="https://www.facebook.com/groups/863439644603943/?sorting_setting=CHRONOLOGICAL">
    Join 20,000+ creators sharing tips and success stories
  </Card>

  <Card title="Reddit" icon="reddit" href="https://www.reddit.com/r/Pictory_Community/">
    Join our Reddit community for discussions and updates
  </Card>

  <Card title="Discord" icon="discord" href="https://discord.gg/ugdAVjht">
    Chat with developers, get quick help, and share feedback
  </Card>
</CardGroup>