مرجع API
Veo 3.1 نص إلى فيديو
استخدم نقطة نهاية تحويل النص إلى فيديو لإنشاء مهمة غير متزامنة.
01
نظرة عامة
استخدم نقطة نهاية تحويل النص إلى فيديو مع نموذج مدعوم. استخدم معرّف المهمة المُعاد لاسترداد حالتها، أو أدخل callback_url للتسليمات الموثقة أدناه.
البدء السريع
- أنشئ مفتاح API واضبطه كـ RUNAPI_API_KEY.
- اختر نموذجاً مدعوماً وأرسل طلب POST يطابق مخطط ذلك النموذج.
- احفظ معرّف المهمة المُعاد، ثم استطلع الحالة حتى تبلغ حالة نهائية أو تعالج عمليات الاستدعاء الموثقة أدناه.
نقطة النهاية
- عنوان URL الأساسي
https://runapi.ai- إصدار API
v1- المصادقة
Authorization: Bearer YOUR_API_TOKEN
02
النماذج المدعومة
افتح صفحة النموذج للاطلاع على التسعير الحالي وحدود المعدل وتفاصيل الاستخدام التجاري.
03
نص JSONمخطط الطلب
تعتمد الحقول والقيم المسموح بها على النموذج المحدد. عند التوفير، يستقبل callback_url عمليات تسليم المهمة الموثّقة أدناه.
veo-3.112 حقل
aspect_ratiostring
اختياري
القيم المسموح بها:
16:9, 9:16, auto
callback_urlstring
اختياري
duration_secondsinteger
اختياري
القيم المسموح بها:
4, 6, 8
enable_translationboolean
اختياري
first_frame_image_urlstring
اختياري
input_modestring
اختياري
القيم المسموح بها:
text, first_and_last_frames, reference
last_frame_image_urlstring
اختياري
modelstring
اختياري
promptstring
اختياري
reference_image_urlsarray
اختياري
نطاق العناصر:
1 - 3
seedsinteger
اختياري
watermarkstring
اختياري
veo-3.1-fast12 حقل
aspect_ratiostring
اختياري
القيم المسموح بها:
16:9, 9:16, auto
callback_urlstring
اختياري
duration_secondsinteger
اختياري
القيم المسموح بها:
4, 6, 8
enable_translationboolean
اختياري
first_frame_image_urlstring
اختياري
input_modestring
اختياري
القيم المسموح بها:
text, first_and_last_frames, reference
last_frame_image_urlstring
اختياري
modelstring
اختياري
promptstring
اختياري
reference_image_urlsarray
اختياري
نطاق العناصر:
1 - 3
seedsinteger
اختياري
watermarkstring
اختياري
veo-3.1-lite11 حقل
aspect_ratiostring
اختياري
القيم المسموح بها:
16:9, 9:16
callback_urlstring
اختياري
duration_secondsinteger
اختياري
القيم المسموح بها:
4, 6, 8
enable_translationboolean
اختياري
first_frame_image_urlstring
اختياري
input_modestring
اختياري
القيم المسموح بها:
text, first_and_last_frames, reference
القيمة الافتراضية: text
last_frame_image_urlstring
اختياري
modelstring
اختياري
promptstring
اختياري
reference_image_urlsarray
اختياري
نطاق العناصر:
1 - 3
watermarkstring
اختياري
القواعد الشرطية
تسري هذه المتطلبات عندما تتطابق جميع الشروط المدرجة.
-
عندما
model = veo-3.1-lite- مطلوب
- غير مقبول
seeds,output_resolution
-
عندما
duration_seconds = 4,input_mode = reference,model = veo-3.1-lite- مطلوب
- غير مقبول
duration_seconds
-
عندما
duration_seconds = 6,input_mode = reference,model = veo-3.1-lite- مطلوب
- غير مقبول
duration_seconds
04
HTTP 202إنشاء قبول
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"id": {
"type": "string"
},
"status": {
"enum": [
"processing"
],
"type": "string"
},
"task_replayed": {
"type": "boolean"
}
},
"required": [
"id",
"status",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"id": "tsk_reference_demo",
"status": "processing"
}05
HTTP 200الاستطلاع قيد المعالجة
GET /api/v1/veo_3_1/text_to_video/:id
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"id": {
"type": "string"
},
"status": {
"enum": [
"processing"
],
"type": "string"
}
},
"required": [
"id",
"status",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"id": "tsk_reference_demo",
"status": "processing"
}06
HTTP 200اكتمل الاستطلاع
GET /api/v1/veo_3_1/text_to_video/:id
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"id": {
"type": "string"
},
"sources": {
"items": {
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"unevaluatedProperties": false
},
"type": "array"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"videos": {
"items": {
"properties": {
"url": {
"type": "string",
"x-runapi-generated-media": true
}
},
"required": [
"url"
],
"type": "object",
"unevaluatedProperties": false
},
"type": "array"
}
},
"required": [
"id",
"status",
"videos",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"id": "tsk_reference_demo",
"status": "completed",
"videos": [
{
"url": "https://file.runapi.ai/reference-video.mp4"
}
]
}07
HTTP 200فشل الاستطلاع
GET /api/v1/veo_3_1/text_to_video/:id
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"error": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"enum": [
"failed"
],
"type": "string"
}
},
"required": [
"id",
"status",
"error",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"error": "Task processing failed.",
"id": "tsk_reference_demo",
"status": "failed"
}08
HTTP 200استدعاء العميل: مكتمل
POST callback_url
مخطط الاستجابة
JSON
{
"properties": {
"id": {
"type": "string"
},
"sources": {
"items": {
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"unevaluatedProperties": false
},
"type": "array"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"videos": {
"items": {
"properties": {
"url": {
"type": "string",
"x-runapi-generated-media": true
}
},
"required": [
"url"
],
"type": "object",
"unevaluatedProperties": false
},
"type": "array"
}
},
"required": [
"id",
"status",
"videos"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"id": "tsk_reference_demo",
"status": "completed",
"videos": [
{
"url": "https://file.runapi.ai/reference-video.mp4"
}
]
}09
HTTP 200استدعاء العميل: فشل
POST callback_url
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"code": {
"type": "string"
},
"limit_cents": {
"type": "integer"
},
"message": {
"type": "string"
},
"reset_at": {
"format": "date-time",
"type": [
"string",
"null"
]
},
"used_cents": {
"type": "integer"
},
"window": {
"enum": [
"1h",
"1d",
"7d",
"daily",
"weekly",
"monthly",
"lifetime"
],
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"unevaluatedProperties": false
}
]
},
"id": {
"type": "string"
},
"status": {
"enum": [
"failed"
],
"type": "string"
}
},
"required": [
"id",
"status",
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": {
"code": "generation_failed",
"message": "Task processing failed."
},
"id": "tsk_reference_demo",
"status": "failed"
}10
HTTP 401الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Authentication required"
}11
HTTP 401الأخطاء
GET /api/v1/veo_3_1/text_to_video/:id
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Authentication required"
}12
HTTP 400الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"oneOf": [
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
},
{
"properties": {
"error": {
"description": "ملخص التحقق القابل للقراءة البشرية.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "رسائل التحقق مفتاحها حقل الطلب العام، مع مصفوفة من السلاسل القابلة للقراءة البشرية لكل حقل.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
]
}مثال على الاستجابة
JSON
{
"error": "model must be one of: veo-3.1, veo-3.1-fast, veo-3.1-lite"
}13
HTTP 402الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Insufficient balance"
}14
HTTP 429الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "API key credit limit exceeded"
}15
HTTP 409الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "The request uses features that are not supported for the selected model"
}16
HTTP 429الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Rate limit reached. Please retry later."
}17
HTTP 503الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Service under maintenance, please try again later"
}18
HTTP 504الأخطاء
POST /api/v1/veo_3_1/text_to_video
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "The request timed out"
}19
HTTP 404الأخطاء
GET /api/v1/veo_3_1/text_to_video/:id
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Task with id 'tsk_reference_demo' not found"
}20
نماذج الأكواد المولَّدة
استخدم cURL مباشرةً، أو ثبّت SDK للغة البرمجة التي تستخدمها. كل نموذج يُرسل الطلب الذي تم التحقق من صحته كما هو موضح في هذا المرجع.
التثبيت
Shell
pip install runapi-veo-3-1
PYTHON
import os
from runapi.veo_3_1 import Veo31Client
client = Veo31Client(api_key=os.environ["RUNAPI_API_KEY"])
task = client.text_to_video.create(
model="veo-3.1",
prompt="A paper kite flying above a quiet coastal town at sunrise."
)