Skip to main content

​
Get Your API Key

First, you’ll need an API key to authenticate your requests.
1

Sign up or log in

Go to api.slidevid.ai and create an account or log in
2

Navigate to API settings

Go to Settings → API Keys in your dashboard
3

Generate API key

Click “Generate New API Key” and save it securely
Keep your API key secret! Never commit it to version control or share it publicly.

​
Your First Video

Let’s create a simple educational video using the Class project type.

​
Step 1: List Available Avatars

First, let’s see which avatars are available: 
curl -X GET "https://api.slidevid.ai/v1/avatar/list" \
  -H "x-api-key: your_api_key_here"

{
  "success": true,
  "data": {
    "avatars": [
      {
        "id": "avatar_sarah_01",
        "name": "Sarah",
        "gender": "Female",
        "age": "Young",
        "type": "Realistic",
        "thumbnail": "https://...",
        "isCustom": false
      }
    ],
    "total": 50
  }
}

​
Step 2: List Available Voices

Now let’s get the available voices: 
curl -X GET "https://api.slidevid.ai/v1/voice/list?language=English&gender=Female" \
  -H "x-api-key: your_api_key_here"

{
  "success": true,
  "data": {
    "voices": [
      {
        "id": "1004",
        "voiceId": "tzX5paJ07p5hyWFcU3uG",
        "name": "Jude",
        "gender": "Male",
        "language": "English",
        "accent": "British"
      }
    ],
    "total": 150
  }
}

​
Step 3: Create Your Video

Now that you have an avatar ID and voice ID, create your video: 
curl -X POST "https://api.slidevid.ai/v1/project/create" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "class",
    "name": "My First Tutorial",
    "script": "Hello! Welcome to this tutorial. Today, I will show you how to use our amazing product. It is very simple and easy to understand. Let me guide you through the key features.",
    "avatarId": "avatar_sarah_01",
    "voiceId": "tzX5paJ07p5hyWFcU3uG",
    "webhook": "https://your-domain.com/webhook"
  }'

{
  "success": true,
  "message": "Project created successfully",
  "data": {
    "projectId": "proj_abc123",
    "status": "processing",
  }
}

​
Step 4: Receive Webhook Notification

When your video is ready, we’ll send a POST request to your webhook URL: 
{
  "event": "project.completed",
  "projectId": "proj_abc123",
  "status": "completed",
  "video": {
    "id": "video_xyz789",
    "url": "https://cdn.tryslidevid.ai/videos/xyz789.mp4",
    "duration": 45,
    "thumbnail": "https://cdn.tryslidevid.ai/thumbnails/xyz789.jpg"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "completedAt": "2024-01-15T10:33:00Z"
}
Congratulations! You’ve just created your first AI video with SlideVid.

​
Next Steps

Add Music & Captions

Enhance your videos with background music and captions

View Examples

See complete code examples for different use cases

Use Templates

Create personalized videos at scale with templates

Complete Workflow

Learn the end-to-end video creation process

​
Common Issues

Make sure your API key is correct and included in the x-api-key header. API keys can be managed in your dashboard settings.
Double-check that the IDs exist by listing resources first. IDs are case-sensitive.
Scripts should be between 10 and 5000 characters. Very short scripts may not generate meaningful videos.
Ensure your webhook URL is publicly accessible and returns a 200 status code. Test it with a tool like webhook.site first.

​
Tips for Better Videos

Write natural scripts: Write as if you’re speaking to a friend. Avoid overly formal or robotic language.
Match voice to avatar: Choose voices that match your avatar’s age and gender for more authentic results.
Add pauses: Use commas and periods naturally to create appropriate pauses in speech.
Test webhooks: Use services like webhook.site to test your webhook integration before going live.