مرجع API

مستندات کامل API برای تولید ویدیو Veo 3.1 AI

نمای کلی

Veo 3.1 API به شما امکان می‌دهد ویدیوهای AI را به صورت برنامه‌نویسی از توضیحات متنی یا تصاویر ایجاد کنید. RESTful API ما طراحی شده تا ساده، قدرتمند و آسان برای ادغام در برنامه‌های شما باشد.

URL پایه

https://veo3o1.com/api

احراز هویت

تمام درخواست‌های API نیاز به احراز هویت با استفاده از کلید API دارند. کلید API خود را در هدر Authorization قرار دهید:

Authorization: Bearer YOUR_API_KEY

می‌توانید کلیدهای API را از داشبورد حساب خود ایجاد کنید.


ایجاد ویدیو

یک ویدیوی AI جدید از متن یا تصویر ایجاد کنید.

نقطه پایانی

POST /generate-video

بدنه درخواست

{
  "generationType": "text_to_video" | "image_to_video",
  "prompt": "Your video description",
  "aspectRatio": "auto" | "16:9" | "9:16",
  "imageUrl": "https://...", // Required if generationType is "image_to_video"
  "imageKey": "r2-key" // Optional, for uploaded images
}

پارامترها

پارامترنوعالزامیتوضیحات
generationTypestringبلهنوع تولید: text_to_video یا image_to_video
promptstringبلهتوضیحات ویدیویی که می‌خواهید ایجاد کنید
aspectRatiostringخیرنسبت تصویر ویدیو. پیش‌فرض: auto
imageUrlstringشرطیالزامی اگر generationType برابر image_to_video باشد
imageKeystringخیرکلید ذخیره‌سازی برای تصاویر آپلود شده

پاسخ

{
  "code": 0,
  "msg": "Success",
  "data": {
    "uuid": "video-uuid-123",
    "status": "pending",
    "generationType": "text_to_video",
    "prompt": "Your video description",
    "aspectRatio": "16:9",
    "createdAt": "2025-10-16T10:00:00Z"
  }
}

مثال

curl -X POST https://veo3o1.com/api/generate-video \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "generationType": "text_to_video",
    "prompt": "A beautiful sunset over the ocean with waves gently lapping the shore",
    "aspectRatio": "16:9"
  }'

دریافت وضعیت ویدیو

وضعیت درخواست تولید ویدیو را بررسی کنید.

نقطه پایانی

GET /video-status/{uuid}

پارامترها

پارامترنوعالزامیتوضیحات
uuidstringبلهUUID ویدیو از درخواست تولید

پاسخ

{
  "code": 0,
  "msg": "Success",
  "data": {
    "uuid": "video-uuid-123",
    "status": "completed" | "pending" | "processing" | "failed",
    "videoUrl": "https://...", // Available when status is "completed"
    "progress": 85, // Processing progress (0-100)
    "estimatedTime": 120 // Estimated seconds remaining
  }
}

مقادیر وضعیت

  • pending: ویدیو در صف پردازش است
  • processing: ویدیو در حال تولید است
  • completed: ویدیو آماده و قابل دانلود است
  • failed: تولید ناموفق بود (پیام خطا را بررسی کنید)

آپلود تصویر

یک تصویر برای تولید تصویر به ویدیو آپلود کنید.

نقطه پایانی

POST /upload-video-image

درخواست

از multipart/form-data برای آپلود فایل تصویر استفاده کنید.

curl -X POST https://veo3o1.com/api/upload-video-image \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/image.jpg"

پاسخ

{
  "code": 0,
  "msg": "Upload successful",
  "data": {
    "imageUrl": "https://...",
    "imageKey": "r2-key-123"
  }
}

فرمت‌های پشتیبانی شده

  • JPEG/JPG
  • PNG
  • WebP
  • حداکثر اندازه فایل: 50MB

کدهای خطا

کدتوضیحات
0موفقیت
1000پارامترهای نامعتبر
1001اعتبار ناکافی
1002احراز هویت ناموفق
1003محدودیت نرخ تجاوز شده
5000خطای سرور

نمونه پاسخ خطا

{
  "code": 1001,
  "msg": "Insufficient credits",
  "data": {
    "required": 2,
    "current": 0
  }
}

بهترین شیوه‌ها

  1. نظرسنجی مسئولانه: وضعیت ویدیو را هر 5-10 ثانیه بررسی کنید، نه به طور مداوم
  2. مدیریت خطا: منطق تلاش مجدد با backoff نمایی پیاده‌سازی کنید
  3. کش کردن نتایج: ویدیوهای تولید شده را ذخیره کنید تا از تولید مجدد جلوگیری شود
  4. استفاده از webhooks: کارآمدتر از نظرسنجی برای اعلان‌های تکمیل
  5. اعتبارسنجی ورودی‌ها: طول prompt و فرمت‌های تصویر را قبل از فراخوانی API بررسی کنید

پشتیبانی

به کمک با API نیاز دارید؟