מדריך ה-API
כל נקודות הקצה
Base URL https://www.wtflow-studio.com/api/v1
Authorization Bearer wtf_live_…
Content-Type application/jsonחשבון
החשבון, היתרה וקודי מתנה.
החשבון, החבילה והיתרה
למי שייך המפתח, איזו חבילה פעילה וכמה קרדיטים נשארו.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/me" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "k17c3e8w2m5p9x4d6f1h0b7q3t8n2r5a",
"email": "dana@brightdesk.example",
"name": "Dana",
"balance": 4120,
"admin": false,
"plan": {
"id": "pro",
"name": "Pro",
"status": "active",
"interval": "month",
"creditsPerMonth": 5000,
"periodEnd": "2026-10-29T08:00:00.000Z",
"cancelAtPeriodEnd": false
},
"key": {
"scope": "user",
"rateLimitPerMinute": 60
}
}מימוש קוד מתנה
מוסיף את הקרדיטים של הקוד ליתרה. כל קוד עובד פעם אחת לכל חשבון.
גוף הבקשה (JSON)
codestringחובהקוד המתנה.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/gifts/redeem" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "WTF-7K2MQ-X9P4R"
}'{
"credits": 500,
"balance": 4620
}פרויקטים
יצירה, קריאה ומחיקה של פרויקטים.
רשימת פרויקטים
הפרויקטים שלכם, מהחדש לישן. כדי לקבל עמוד נוסף שולחים את nextCursor בפרמטר cursor.
פרמטרים בכתובת (query)
limitintegerqueryכמה להחזיר (1 עד 100, ברירת מחדל 20). ברירת מחדל:
20cursorstringqueryה-nextCursor מהעמוד הקודם.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "research",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v"
}
],
"nextCursor": null
}יצירת פרויקט
יוצר פרויקט מבריף. שום דבר לא מחויב, אלא אם runResearch הוא true. אפשר להתחיל את המחקר גם אחר כך.
גוף הבקשה (JSON)
urlstringאתר העסק. שלב המחקר קורא אותו.
promptstringמה הסרטון צריך לעשות, במילים שלכם (עד 4,000 תווים). צריך url, prompt או את שניהם.
namestringשם הפרויקט. ברירת המחדל: הדומיין של האתר או תחילת הבריף.
videoTypestringסוג הסרטון, למשל סרטון מוצר או השקת פיצ׳ר. ברירת מחדל:
"Product video"goalstringמה הסרטון צריך להשיג.
audiencestringלמי הוא מיועד.
language"he" | "en"שפת הסרטון. ברירת מחדל:
"he"durationintegerאורך מבוקש בשניות (6 עד 180). ברירת מחדל:
30aspect"16:9" | "9:16" | "1:1"פורמט הפריים. ברירת מחדל:
"16:9"narration"auto" | "none" | "voice"auto: המודל מחליט. none: טקסט על המסך בלבד. voice: קריינות. ברירת מחדל:
"auto"assetIdsstring[]קבצים שכבר העליתם (מזהי asset) שיצורפו לפרויקט.
runResearchbooleanלהתחיל את המחקר מיד. עולה קרדיטים. ברירת המחדל false. ברירת מחדל:
false
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"language": "en",
"duration": 30,
"aspect": "16:9"
}'{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "research",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "run_research",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": null,
"researchApproved": false,
"sources": [],
"directions": [],
"chosenDirection": null,
"script": null,
"scriptApproved": false
}פרטי פרויקט
הפרויקט כולו: בריף, מחקר, כיוונים, תסריט, סטטוס, ו-next שאומר מה הקריאה הבאה. בזמן ש-status.busy הוא true בודקים שוב כל 3 עד 5 שניות.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "script",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "choose_direction",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": {
"company": {
"name": "Brightdesk",
"oneLiner": "A shared inbox for small support teams",
"category": "saas"
},
"whatItDoes": "Brightdesk puts email, chat and WhatsApp conversations in one inbox, with assignment, saved replies and response-time timers.",
"audience": [
"Support leads at 5 to 50 person companies",
"Founders who still answer support themselves"
],
"problem": "Requests arrive in five places, and some are never answered.",
"benefits": [
{
"text": "Every channel lands in one inbox",
"source": "https://brightdesk.example/features",
"kind": "fact"
}
],
"messages": [
"One inbox for every customer conversation"
],
"tone": {
"words": [
"calm",
"direct",
"practical"
],
"description": "Plain words, short sentences."
},
"facts": [
{
"text": "Free plan for up to 2 agents",
"source": "https://brightdesk.example/pricing",
"kind": "fact"
}
],
"assumptions": [
{
"text": "Most customers sell online",
"source": "",
"kind": "assumption"
}
],
"brand": {
"colors": [
"#0F172A",
"#22C55E"
],
"fonts": [
"Inter"
],
"notes": "Dark navy with a green accent"
},
"productDetails": [
"Shared inbox",
"Saved replies",
"Response-time timers"
],
"questions": [
{
"question": "Should the video mention the free plan?",
"impact": "It changes the call to action"
}
],
"summary": "Brightdesk is a shared inbox for small support teams. The site stresses one inbox for every channel and a free plan for two agents."
},
"researchApproved": true,
"sources": [],
"directions": [
{
"id": "d1",
"title": "Five inboxes, one team",
"promise": "Nothing gets lost again",
"hook": "Five notification sounds at once, then silence",
"tone": "Calm and exact",
"motion": "Cards fly in from five edges and stack into one list",
"cta": "Start free with two agents",
"why": "The site's main message is one inbox for every channel"
},
{
"id": "d2",
"title": "The 9:02 rush",
"promise": "Monday morning without the panic",
"hook": "A clock hits 9:02 and the queue explodes",
"tone": "Light, a little funny",
"motion": "Counters roll down as tickets get assigned",
"cta": "Try Brightdesk free",
"why": "Support leads remember the Monday spike"
}
],
"chosenDirection": null,
"script": null,
"scriptApproved": false
}מחיקת פרויקט
מוחק את הפרויקט עם הקומפוזיציה, הגרסאות, ההודעות והייצואים. הקבצים נשארים בספרייה שלכם.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X DELETE "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"deleted": true
}שלבי ההפקה
מחקר, כיוונים, תסריט והקומפוזיציה הבנויה.
הרצת מחקר
סורק את הדפים הפנימיים של האתר עם צילומי מסך אמיתיים ותמונות מותג, ואז המודל כותב את הבריף העסקי. לוקח בערך דקה עד שלוש באתר קטן, ויותר באתר גדול. בודקים את הפרויקט עד ש-status.busy הוא false, ואז קוראים את research. הרצה נוספת מחליפה את הבריף.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/research" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "research",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": true,
"step": "Reading the website",
"error": null,
"since": "2026-09-29T09:41:00.000Z"
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "wait",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": null,
"researchApproved": false,
"sources": [],
"directions": [],
"chosenDirection": null,
"script": null,
"scriptApproved": false
}עריכת המחקר
משנה את הבריף לפני האישור. שדות שנשלחים מחליפים את הקיימים, והשאר נשאר. אפשר גם לכתוב את כל הבריף בעצמכם ולוותר על קריאת המחקר.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
גוף הבקשה (JSON)
researchResearchחובהשדות הבריף לעדכון. כל שדה עליון שנשלח מחליף את הקיים.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X PATCH "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/research" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"research": {
"messages": [
"One inbox for every customer conversation",
"Free for two agents"
],
"tone": {
"words": [
"calm",
"direct"
],
"description": "Plain words."
}
}
}'{
"research": {
"company": {
"name": "Brightdesk",
"oneLiner": "A shared inbox for small support teams",
"category": "saas"
},
"whatItDoes": "Brightdesk puts email, chat and WhatsApp conversations in one inbox, with assignment, saved replies and response-time timers.",
"audience": [
"Support leads at 5 to 50 person companies",
"Founders who still answer support themselves"
],
"problem": "Requests arrive in five places, and some are never answered.",
"benefits": [
{
"text": "Every channel lands in one inbox",
"source": "https://brightdesk.example/features",
"kind": "fact"
}
],
"messages": [
"One inbox for every customer conversation"
],
"tone": {
"words": [
"calm",
"direct",
"practical"
],
"description": "Plain words, short sentences."
},
"facts": [
{
"text": "Free plan for up to 2 agents",
"source": "https://brightdesk.example/pricing",
"kind": "fact"
}
],
"assumptions": [
{
"text": "Most customers sell online",
"source": "",
"kind": "assumption"
}
],
"brand": {
"colors": [
"#0F172A",
"#22C55E"
],
"fonts": [
"Inter"
],
"notes": "Dark navy with a green accent"
},
"productDetails": [
"Shared inbox",
"Saved replies",
"Response-time timers"
],
"questions": [
{
"question": "Should the video mention the free plan?",
"impact": "It changes the call to action"
}
],
"summary": "Brightdesk is a shared inbox for small support teams. The site stresses one inbox for every channel and a free plan for two agents."
},
"researchApproved": false
}אישור המחקר
נועל את הבריף ומבקש מהמודל כיוונים קריאייטיביים (בדרך כלל שלושה). בודקים את הפרויקט עד ש-status.busy הוא false, ואז קוראים את הכיוונים.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/research/approve" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "script",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": true,
"step": "Creative directions",
"error": null,
"since": "2026-09-29T09:41:00.000Z"
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "wait",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": {
"company": {
"name": "Brightdesk",
"oneLiner": "A shared inbox for small support teams",
"category": "saas"
},
"whatItDoes": "Brightdesk puts email, chat and WhatsApp conversations in one inbox, with assignment, saved replies and response-time timers.",
"audience": [
"Support leads at 5 to 50 person companies",
"Founders who still answer support themselves"
],
"problem": "Requests arrive in five places, and some are never answered.",
"benefits": [
{
"text": "Every channel lands in one inbox",
"source": "https://brightdesk.example/features",
"kind": "fact"
}
],
"messages": [
"One inbox for every customer conversation"
],
"tone": {
"words": [
"calm",
"direct",
"practical"
],
"description": "Plain words, short sentences."
},
"facts": [
{
"text": "Free plan for up to 2 agents",
"source": "https://brightdesk.example/pricing",
"kind": "fact"
}
],
"assumptions": [
{
"text": "Most customers sell online",
"source": "",
"kind": "assumption"
}
],
"brand": {
"colors": [
"#0F172A",
"#22C55E"
],
"fonts": [
"Inter"
],
"notes": "Dark navy with a green accent"
},
"productDetails": [
"Shared inbox",
"Saved replies",
"Response-time timers"
],
"questions": [
{
"question": "Should the video mention the free plan?",
"impact": "It changes the call to action"
}
],
"summary": "Brightdesk is a shared inbox for small support teams. The site stresses one inbox for every channel and a free plan for two agents."
},
"researchApproved": true,
"sources": [],
"directions": [],
"chosenDirection": null,
"script": null,
"scriptApproved": false
}הכיוונים הקריאייטיביים
הכיוונים שנכתבו אחרי אישור המחקר, והכיוון שנבחר.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/directions" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "d1",
"title": "Five inboxes, one team",
"promise": "Nothing gets lost again",
"hook": "Five notification sounds at once, then silence",
"tone": "Calm and exact",
"motion": "Cards fly in from five edges and stack into one list",
"cta": "Start free with two agents",
"why": "The site's main message is one inbox for every channel"
},
{
"id": "d2",
"title": "The 9:02 rush",
"promise": "Monday morning without the panic",
"hook": "A clock hits 9:02 and the queue explodes",
"tone": "Light, a little funny",
"motion": "Counters roll down as tickets get assigned",
"cta": "Try Brightdesk free",
"why": "Support leads remember the Monday spike"
}
],
"chosenDirection": null,
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
}
}בחירת כיוון
בוחר כיוון וכותב לפיו תסריט סצנה אחר סצנה. בודקים את הפרויקט, ואז קוראים את התסריט.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
directionIdstringpathחובהמזהה כיוון מתוך רשימת הכיוונים (d1, d2…).
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/directions/d1/choose" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "script",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": true,
"step": "Writing the script",
"error": null,
"since": "2026-09-29T09:41:00.000Z"
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "wait",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": {
"company": {
"name": "Brightdesk",
"oneLiner": "A shared inbox for small support teams",
"category": "saas"
},
"whatItDoes": "Brightdesk puts email, chat and WhatsApp conversations in one inbox, with assignment, saved replies and response-time timers.",
"audience": [
"Support leads at 5 to 50 person companies",
"Founders who still answer support themselves"
],
"problem": "Requests arrive in five places, and some are never answered.",
"benefits": [
{
"text": "Every channel lands in one inbox",
"source": "https://brightdesk.example/features",
"kind": "fact"
}
],
"messages": [
"One inbox for every customer conversation"
],
"tone": {
"words": [
"calm",
"direct",
"practical"
],
"description": "Plain words, short sentences."
},
"facts": [
{
"text": "Free plan for up to 2 agents",
"source": "https://brightdesk.example/pricing",
"kind": "fact"
}
],
"assumptions": [
{
"text": "Most customers sell online",
"source": "",
"kind": "assumption"
}
],
"brand": {
"colors": [
"#0F172A",
"#22C55E"
],
"fonts": [
"Inter"
],
"notes": "Dark navy with a green accent"
},
"productDetails": [
"Shared inbox",
"Saved replies",
"Response-time timers"
],
"questions": [
{
"question": "Should the video mention the free plan?",
"impact": "It changes the call to action"
}
],
"summary": "Brightdesk is a shared inbox for small support teams. The site stresses one inbox for every channel and a free plan for two agents."
},
"researchApproved": true,
"sources": [],
"directions": [
{
"id": "d1",
"title": "Five inboxes, one team",
"promise": "Nothing gets lost again",
"hook": "Five notification sounds at once, then silence",
"tone": "Calm and exact",
"motion": "Cards fly in from five edges and stack into one list",
"cta": "Start free with two agents",
"why": "The site's main message is one inbox for every channel"
},
{
"id": "d2",
"title": "The 9:02 rush",
"promise": "Monday morning without the panic",
"hook": "A clock hits 9:02 and the queue explodes",
"tone": "Light, a little funny",
"motion": "Counters roll down as tickets get assigned",
"cta": "Try Brightdesk free",
"why": "Support leads remember the Monday spike"
}
],
"chosenDirection": "d1",
"script": null,
"scriptApproved": false
}קריאת התסריט
התסריט, האם אושר, והסטטוס של הפרויקט.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/script" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"script": {
"directionId": "d1",
"title": "Five inboxes, one team",
"narration": {
"use": false,
"why": "On-screen text carries a 30-second product video better than a voice"
},
"scenes": [
{
"id": "sc1",
"role": "hook",
"name": "Five pings",
"duration": 4,
"voiceover": "",
"onScreenText": "5 inboxes. 1 team.",
"visual": "Five app icons pulse on a navy background",
"motion": "Icons pop in on each ping",
"assets": []
},
{
"id": "sc2",
"role": "solution",
"name": "One list",
"duration": 6,
"voiceover": "",
"onScreenText": "Everything lands in one place",
"visual": "The five streams merge into one clean list",
"motion": "Cards slide into a single column",
"assets": [
"kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q"
]
},
{
"id": "sc3",
"role": "cta",
"name": "Start free",
"duration": 4,
"voiceover": "",
"onScreenText": "Free for 2 agents",
"visual": "Logo and the button",
"motion": "Logo settles, button pulses once",
"assets": []
}
],
"musicPrompt": "calm modern electronic, 100 bpm, instrumental"
},
"approved": false,
"directionId": "d1",
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
}
}החלפת התסריט
שומר גרסה שלכם של התסריט (האובייקט כולו). הוא מנוקה כמו תסריט שהמודל כתב: עד 16 סצנות, 1 עד 30 שניות כל אחת.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
גוף הבקשה (JSON)
scriptScriptחובההתסריט המלא.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X PUT "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/script" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"script": {
"directionId": "d1",
"title": "Five inboxes, one team",
"narration": {
"use": false,
"why": "On-screen text carries a 30-second product video better than a voice"
},
"scenes": [
{
"id": "sc1",
"role": "hook",
"name": "Five pings",
"duration": 4,
"voiceover": "",
"onScreenText": "5 inboxes. 1 team.",
"visual": "Five app icons pulse on a navy background",
"motion": "Icons pop in on each ping",
"assets": []
},
{
"id": "sc2",
"role": "solution",
"name": "One list",
"duration": 6,
"voiceover": "",
"onScreenText": "Everything lands in one place",
"visual": "The five streams merge into one clean list",
"motion": "Cards slide into a single column",
"assets": [
"kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q"
]
},
{
"id": "sc3",
"role": "cta",
"name": "Start free",
"duration": 4,
"voiceover": "",
"onScreenText": "Free for 2 agents",
"visual": "Logo and the button",
"motion": "Logo settles, button pulses once",
"assets": []
}
],
"musicPrompt": "calm modern electronic, 100 bpm, instrumental"
}
}'{
"script": {
"directionId": "d1",
"title": "Five inboxes, one team",
"narration": {
"use": false,
"why": "On-screen text carries a 30-second product video better than a voice"
},
"scenes": [
{
"id": "sc1",
"role": "hook",
"name": "Five pings",
"duration": 4,
"voiceover": "",
"onScreenText": "5 inboxes. 1 team.",
"visual": "Five app icons pulse on a navy background",
"motion": "Icons pop in on each ping",
"assets": []
},
{
"id": "sc2",
"role": "solution",
"name": "One list",
"duration": 6,
"voiceover": "",
"onScreenText": "Everything lands in one place",
"visual": "The five streams merge into one clean list",
"motion": "Cards slide into a single column",
"assets": [
"kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q"
]
},
{
"id": "sc3",
"role": "cta",
"name": "Start free",
"duration": 4,
"voiceover": "",
"onScreenText": "Free for 2 agents",
"visual": "Logo and the button",
"motion": "Logo settles, button pulses once",
"assets": []
}
],
"musicPrompt": "calm modern electronic, 100 bpm, instrumental"
},
"approved": false,
"directionId": "d1",
"status": {
"busy": false,
"step": null,
"error": null,
"since": null
}
}אישור התסריט
בונה את הסצנות (הקומפוזיציה) מהתסריט. עם withMotion (ברירת מחדל true) המודל כותב גם שכבות מושן לכל סצנה שהסטוריבורד תכנן לה; שכבות הטיוטה הראשונה כלולות במחיר ההפקה. מוזיקה ואפקטים נבחרים מספריית הסטוק בלי חיוב.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
גוף הבקשה (JSON)
withMotionbooleanלכתוב גם שכבות מושן לסצנות שהסטוריבורד תכנן להן. ברירת מחדל:
true
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/script/approve" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"withMotion": true
}'{
"id": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"name": "brightdesk.example",
"stage": "storyboard",
"aspect": "16:9",
"language": "en",
"duration": null,
"status": {
"busy": true,
"step": "Building the scenes",
"error": null,
"since": "2026-09-29T09:41:00.000Z"
},
"reviewStatus": "draft",
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z",
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"next": "wait",
"hasComposition": false,
"brief": {
"url": "https://brightdesk.example",
"prompt": "A 30-second launch video for small support teams. Calm, confident, no hype.",
"videoType": "Product video",
"goal": "Sign-ups for the free plan",
"audience": "Support leads at companies of 5 to 50 people",
"language": "en",
"duration": 30,
"aspect": "16:9",
"narration": "auto"
},
"research": {
"company": {
"name": "Brightdesk",
"oneLiner": "A shared inbox for small support teams",
"category": "saas"
},
"whatItDoes": "Brightdesk puts email, chat and WhatsApp conversations in one inbox, with assignment, saved replies and response-time timers.",
"audience": [
"Support leads at 5 to 50 person companies",
"Founders who still answer support themselves"
],
"problem": "Requests arrive in five places, and some are never answered.",
"benefits": [
{
"text": "Every channel lands in one inbox",
"source": "https://brightdesk.example/features",
"kind": "fact"
}
],
"messages": [
"One inbox for every customer conversation"
],
"tone": {
"words": [
"calm",
"direct",
"practical"
],
"description": "Plain words, short sentences."
},
"facts": [
{
"text": "Free plan for up to 2 agents",
"source": "https://brightdesk.example/pricing",
"kind": "fact"
}
],
"assumptions": [
{
"text": "Most customers sell online",
"source": "",
"kind": "assumption"
}
],
"brand": {
"colors": [
"#0F172A",
"#22C55E"
],
"fonts": [
"Inter"
],
"notes": "Dark navy with a green accent"
},
"productDetails": [
"Shared inbox",
"Saved replies",
"Response-time timers"
],
"questions": [
{
"question": "Should the video mention the free plan?",
"impact": "It changes the call to action"
}
],
"summary": "Brightdesk is a shared inbox for small support teams. The site stresses one inbox for every channel and a free plan for two agents."
},
"researchApproved": true,
"sources": [],
"directions": [
{
"id": "d1",
"title": "Five inboxes, one team",
"promise": "Nothing gets lost again",
"hook": "Five notification sounds at once, then silence",
"tone": "Calm and exact",
"motion": "Cards fly in from five edges and stack into one list",
"cta": "Start free with two agents",
"why": "The site's main message is one inbox for every channel"
},
{
"id": "d2",
"title": "The 9:02 rush",
"promise": "Monday morning without the panic",
"hook": "A clock hits 9:02 and the queue explodes",
"tone": "Light, a little funny",
"motion": "Counters roll down as tickets get assigned",
"cta": "Try Brightdesk free",
"why": "Support leads remember the Monday spike"
}
],
"chosenDirection": "d1",
"script": {
"directionId": "d1",
"title": "Five inboxes, one team",
"narration": {
"use": false,
"why": "On-screen text carries a 30-second product video better than a voice"
},
"scenes": [
{
"id": "sc1",
"role": "hook",
"name": "Five pings",
"duration": 4,
"voiceover": "",
"onScreenText": "5 inboxes. 1 team.",
"visual": "Five app icons pulse on a navy background",
"motion": "Icons pop in on each ping",
"assets": []
},
{
"id": "sc2",
"role": "solution",
"name": "One list",
"duration": 6,
"voiceover": "",
"onScreenText": "Everything lands in one place",
"visual": "The five streams merge into one clean list",
"motion": "Cards slide into a single column",
"assets": [
"kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q"
]
},
{
"id": "sc3",
"role": "cta",
"name": "Start free",
"duration": 4,
"voiceover": "",
"onScreenText": "Free for 2 agents",
"visual": "Logo and the button",
"motion": "Logo settles, button pulses once",
"assets": []
}
],
"musicPrompt": "calm modern electronic, 100 bpm, instrumental"
},
"scriptApproved": true
}קריאת הקומפוזיציה
הסרטון הבנוי כ-JSON: סצנות, שכבות, תזמון, עיצוב, מוזיקה ואפקטים. קובץ MP4 מרונדר בעורך של WTFLOW בדפדפן: פותחים את editorUrl ומייצאים. רינדור בשרת עוד לא זמין.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/composition" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"projectId": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"revision": 7,
"updatedAt": "2026-09-29T09:42:10.000Z",
"duration": 14,
"composition": {
"version": 1,
"aspect": "16:9",
"fps": 30,
"theme": {
"bg": "#0F172A",
"surface": "#1E293B",
"text": "#F8FAFC",
"muted": "#94A3B8",
"accent": "#22C55E",
"accent2": "#38BDF8",
"headingFont": "Inter",
"bodyFont": "Inter",
"radius": 16,
"direction": "ltr",
"language": "en"
},
"scenes": [
{
"id": "s1",
"name": "Five pings",
"role": "hook",
"duration": 4,
"background": {
"type": "gradient",
"from": "#0F172A",
"to": "#1E293B",
"angle": 135,
"pattern": "glow"
},
"layers": [
{
"id": "t1",
"type": "text",
"name": "Headline",
"text": "5 inboxes. 1 team.",
"start": 0.3,
"end": 4,
"x": 0.5,
"y": 0.5,
"w": 0.8,
"h": 0.2,
"font": "Inter",
"weight": 800,
"size": 96,
"color": "#F8FAFC",
"align": "center",
"enter": {
"preset": "rise",
"duration": 0.6,
"delay": 0,
"ease": "out"
}
}
],
"transition": {
"type": "fade",
"duration": 0.4
},
"voiceover": {
"text": "",
"status": "none"
},
"sfx": [
{
"id": "fx1",
"name": "Ping",
"at": 0.3,
"query": "soft notification ping",
"volume": 0.65,
"status": "ready",
"assetId": "kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q",
"title": "Soft Ping 02"
}
]
}
],
"music": {
"query": "calm modern electronic",
"title": "Quiet Motion",
"assetId": "kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q",
"volume": 0.6,
"status": "ready"
},
"voiceVolume": 1,
"captions": false
},
"editorUrl": "https://www.wtflow-studio.com/p/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"rendering": {
"serverSide": false,
"message": "MP4 export runs in the WTFLOW editor, in the browser. Open editorUrl to export. Server-side rendering is not available yet."
}
}צ׳אט ועריכות
צ׳אט עם הפרויקט, אישור עריכות מוצעות ומעקב אחרי עבודות.
הודעות הצ׳אט
הצ׳אט של הפרויקט, מהישן לחדש. תשובה עם pending: true עוד נכתבת. תשובה לבקשת עריכה מגיעה עם proposal.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
פרמטרים בכתובת (query)
limitintegerqueryכמה להחזיר (1 עד 200, ברירת מחדל 50). ברירת מחדל:
50
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/messages" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c7d",
"role": "user",
"stage": "storyboard",
"text": "Make the headline in scene 1 green and shorter",
"pending": false,
"steps": [],
"attachments": [],
"proposal": null,
"createdAt": "2026-09-29T09:41:00.000Z"
},
{
"id": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e",
"role": "assistant",
"stage": "storyboard",
"text": "Changed the headline to “One inbox.” in the accent green.",
"pending": false,
"steps": [
{
"label": "Working on it",
"status": "done",
"detail": null
}
],
"attachments": [],
"proposal": {
"state": "pending",
"summary": "Changed the headline to “One inbox.” in the accent green.",
"changedScenes": [
"Five pings"
],
"changedLayers": [
"Five pings · Headline"
],
"rejected": [],
"mediaCount": 0,
"opCount": 2,
"appliedVersion": null
},
"createdAt": "2026-09-29T09:41:00.000Z"
}
]
}שליחת הודעה בצ׳אט
מדברים עם הפרויקט כמו בצ׳אט של הסטודיו. לפני אישור המחקר ההודעה מעדכנת את הבריף, בשלב התסריט היא מעדכנת את התסריט, ואחרי שנבנו סצנות היא בקשת עריכה שהתשובה עליה מביאה הצעה (proposal) לאישור או לדחייה. בודקים את ההודעות עד שהתשובה כבר לא pending.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
גוף הבקשה (JSON)
textstringחובהההודעה (עד 4,000 תווים).
attachmentsstring[]מזהי קבצים לצרף (עד 10). תמונות נשלחות למודל, ואפשר לבקש לשים אותן בסרטון.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/messages" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "Make the headline in scene 1 green and shorter"
}'{
"messageId": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c7d",
"replyId": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e",
"status": "started",
"poll": "GET /projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/messages until the reply's \"pending\" is false"
}אישור הצעה
מחיל את העריכה שהעוזר הציע. המצב שלפניה נשמר כגרסה, כך שאפשר לחזור אליו בעורך. אם בהצעה יש מדיה בתשלום (קריינות, תמונות, וידאו, שכבות מושן), העבודות האלה מתחילות עכשיו ומחויבות.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
messageIdstringpathחובההודעת העוזר שמחזיקה את ההצעה.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/proposals/n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e/apply" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"messageId": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e",
"state": "applied",
"version": 4,
"revision": 8,
"mediaJobs": 0
}דחיית הצעה
מסמן את ההצעה כנדחתה. שום דבר לא משתנה בסרטון.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
messageIdstringpathחובההודעת העוזר שמחזיקה את ההצעה.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 409project_busyהפרויקט עוד לא במצב שמאפשר את הקריאה הזו.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/proposals/n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e/dismiss" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"messageId": "n97a1d3f5h7k9m2p4r6t8v0x1z3b5c8e",
"state": "dismissed"
}עבודות AI
כל עבודות ה-AI של הפרויקט, מהחדשה לישנה, עם סטטוס, התקדמות, שגיאות והקרדיטים שכל אחת עלתה.
פרמטרים בנתיב
projectIdstringpathחובהמזהה הפרויקט.
פרמטרים בכתובת (query)
limitintegerqueryכמה להחזיר (1 עד 100, ברירת מחדל 50). ברירת מחדל:
50
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/projects/j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v/jobs" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "jd7f9h1k3m5p7r9t1v3x5z7b9d1f3h5k",
"kind": "llm",
"purpose": "research",
"label": "Understanding the business",
"status": "completed",
"progress": 100,
"error": null,
"errorCode": null,
"credits": 38.5,
"createdAt": "2026-09-29T09:41:00.000Z",
"finishedAt": "2026-09-29T09:42:10.000Z"
}
]
}קבצים
הקבצים בספרייה שלכם.
חיפוש בספריית ג׳ני
חיפוש אלמנטים שקופים ואנימציות. מייבאים את הקובץ הרצוי באמצעות import_asset ומשלבים לפי מזהה הנכס.
פרמטרים בכתובת (query)
qstringqueryמילות חיפוש בעברית או באנגלית.
type"3d" | "motion"queryסוג הפריט.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
- 502
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/library" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [],
"total": 0,
"next": "Use import_asset."
}רשימת קבצים
הקבצים שלכם: העלאות, תמונות מהאתר, מדיה שנוצרה ואודיו מהסטוק. עם projectId מקבלים רק את קבצי הפרויקט. קישורי ההורדה זמניים.
פרמטרים בכתובת (query)
projectIdstringqueryרק הקבצים של הפרויקט הזה.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/assets" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q",
"name": "logo.svg",
"kind": "image",
"category": "brand",
"origin": "user",
"projectId": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"status": "ready",
"mime": "image/svg+xml",
"size": 4180,
"width": null,
"height": null,
"duration": null,
"url": "https://…/api/storage/3f7c2a91-…",
"createdAt": "2026-09-29T09:41:00.000Z"
}
]
}ייבוא קובץ מכתובת
מוריד תמונה, וידאו או אודיו (עד 100MB) מכתובת ציבורית לספרייה שלכם. את המזהה שחוזר משתמשים ב-assetIds, בצירופים להודעה או בסצנות התסריט.
גוף הבקשה (JSON)
urlstringחובהכתובת ציבורית של הקובץ.
projectIdstringלשייך לפרויקט הזה.
namestringשם בספרייה. ברירת המחדל: שם הקובץ.
category"brand" | "product" | "image" | "video" | "audio" | "motion"קטגוריה בספרייה.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/assets" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://brightdesk.example/press/logo.png",
"projectId": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"category": "brand"
}'{
"id": "kg2m4p6r8t0v1x3z5b7d9f1h3k5m7p9q",
"name": "logo.png",
"kind": "image",
"category": "brand",
"origin": "user",
"projectId": "j57b2m9x4k8d1c6f3h0q7t5w2n9r4s1v",
"status": "ready",
"mime": "image/png",
"size": 18230,
"width": null,
"height": null,
"duration": null,
"url": "https://…/api/storage/3f7c2a91-…",
"createdAt": "2026-09-29T09:41:00.000Z"
}סקילים
כללי הבית שהמודל מיישם, כולל ייבוא מ-GitHub.
רשימת סקילים
הכללים של הבית שלכם. סקיל פעיל ומוכן נכנס לכל קריאה למודל שהוא רלוונטי לה.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/skills" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "Our CTA",
"description": "How every video ends",
"whenToUse": "",
"instructions": "- The last scene always says “Start free”\n- Logo bottom-right, 12% of the width",
"enabled": true,
"source": "user",
"status": "ready",
"origin": null,
"error": null,
"uses": 3,
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z"
}
]
}יצירת סקיל
מוסיף סט כללים, פעיל מיד.
גוף הבקשה (JSON)
namestringחובה2 עד 5 מילים (עד 80 תווים).
instructionsstringחובההכללים, שורה לכל כלל (עד 8,000 תווים).
descriptionstringמשפט אחד.
whenToUsestringמתי הוא חל. ריק = תמיד.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/skills" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Our CTA",
"description": "How every video ends",
"instructions": "- The last scene always says “Start free”\n- Logo bottom-right, 12% of the width"
}'{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "Our CTA",
"description": "How every video ends",
"whenToUse": "",
"instructions": "- The last scene always says “Start free”\n- Logo bottom-right, 12% of the width",
"enabled": true,
"source": "user",
"status": "ready",
"origin": null,
"error": null,
"uses": 0,
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z"
}פרטי סקיל
סקיל אחד עם כל ההוראות.
פרמטרים בנתיב
skillIdstringpathחובהמזהה הסקיל.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/skills/ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "Our CTA",
"description": "How every video ends",
"whenToUse": "",
"instructions": "- The last scene always says “Start free”",
"enabled": true,
"source": "user",
"status": "ready",
"origin": null,
"error": null,
"uses": 3,
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z"
}עדכון סקיל
משנה כל אחד מהשדות: name, description, whenToUse, instructions או enabled.
פרמטרים בנתיב
skillIdstringpathחובהמזהה הסקיל.
גוף הבקשה (JSON)
namestringשם.
descriptionstringמשפט אחד.
whenToUsestringמתי הוא חל.
instructionsstringהכללים.
enabledbooleanהפעלה או כיבוי.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X PATCH "https://www.wtflow-studio.com/api/v1/skills/ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": false
}'{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "Our CTA",
"description": "How every video ends",
"whenToUse": "",
"instructions": "- The last scene always says “Start free”",
"enabled": false,
"source": "user",
"status": "ready",
"origin": null,
"error": null,
"uses": 3,
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:42:10.000Z"
}מחיקת סקיל
מוחק את הסקיל ואת קבצי המקור שנשמרו לו בייבוא.
פרמטרים בנתיב
skillIdstringpathחובהמזהה הסקיל.
שגיאות אפשריות
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X DELETE "https://www.wtflow-studio.com/api/v1/skills/ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"deleted": true
}גילוי סקילים ממאגר GitHub
מוריד מאגר ציבורי (או תיקייה בתוכו) ומחזיר את הסקילים שנמצאו בו (SKILL.md, README.md וקבצי md אחרים) בסטטוס found. חינם. שום דבר לא נלמד עד שקוראים ל-learn עם המזהים שבחרתם.
גוף הבקשה (JSON)
urlstringחובהקישור למאגר, או לתיקייה בתוכו.
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/skills/import/github" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://github.com/acme/brand-skills/tree/main/skills"
}'{
"discovered": [
{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "brand-voice",
"path": "skills/brand-voice",
"files": 2,
"chars": 5320,
"status": "found"
}
],
"next": "POST /skills/learn with the ids you want to keep. Discovery is free; learning costs credits."
}לימוד סקילים
כל סקיל שבחרתם עובר פעם אחת במודל, שמשאיר את הכללים שמשפיעים על הכתיבה, העיצוב, התזמון והסאונד. בודקים את רשימת הסקילים עד שכל אחד ready (או failed עם הסיבה ב-error).
גוף הבקשה (JSON)
skillIdsstring[]חובהמזהי הסקילים ללימוד (עד 40).
language"he" | "en"שפת הכללים שייכתבו. ברירת מחדל:
"he"
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 402insufficient_creditsאין מספיק קרדיטים כדי להתחיל את השלב.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 404not_foundהמשאב לא קיים, או שהוא שייך לחשבון אחר.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl -X POST "https://www.wtflow-studio.com/api/v1/skills/learn" \
-H "Authorization: Bearer $WTFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"skillIds": [
"ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e"
],
"language": "en"
}'{
"queued": 1,
"data": [
{
"id": "ks1a3c5e7g9j2l4n6q8s0u2w4y6a8c0e",
"name": "brand-voice",
"description": "",
"whenToUse": "",
"instructions": "",
"enabled": false,
"source": "github",
"status": "drafting",
"origin": {
"url": "https://github.com/acme/brand-skills/tree/main/skills",
"path": "skills/brand-voice",
"files": 2,
"chars": 5320
},
"error": null,
"uses": 0,
"createdAt": "2026-09-29T09:41:00.000Z",
"updatedAt": "2026-09-29T09:41:00.000Z"
}
],
"poll": "GET /skills until each skill's status is ready or failed"
}ספריית סטוק
מוזיקה ואפקטים מורשים.
חיפוש מוזיקה ואפקטים
חיפוש בספריית הסטוק המורשית ש-WTFLOW משתמשת בה למוזיקה ולאפקטים. חינם.
פרמטרים בכתובת (query)
type"music" | "sfx"queryחובהmusic או sfx.
qstringqueryחובהמה לחפש, למשל calm corporate piano.
pageintegerqueryעמוד (1 עד 20). ברירת מחדל:
1
שגיאות אפשריות
- 400invalid_requestחסר שדה או שיש שדה מסוג לא נכון.
- 401invalid_api_keyאין מפתח, או שהמפתח שגוי או בוטל.
- 403plan_requiredהחבילה של בעל המפתח לא כוללת את ה-API.
- 429rate_limitedיותר מ-60 בקשות בדקה עם אותו מפתח. מחכים את מספר השניות שב-Retry-After.
כל הקודים מוסברים בשגיאות ומגבלות קצב.
curl "https://www.wtflow-studio.com/api/v1/stock/search?type=music&q=calm%20modern%20electronic" \
-H "Authorization: Bearer $WTFLOW_API_KEY"{
"data": [
{
"id": "a272dc1b-18ec-4b4b-80db-bed216f2f8f5",
"title": "Quiet Motion",
"duration": 142,
"bpm": 100,
"tags": [
"calm",
"electronic",
"corporate"
],
"instrumental": true
}
]
}מטא
על ה-API עצמו.
המסמך הזה
תיאור ה-API בפורמט OpenAPI 3.1. לא צריך מפתח.
curl "https://www.wtflow-studio.com/api/v1/openapi.json"{
"openapi": "3.1.0",
"info": {
"title": "WTFLOW API",
"version": "1.0.0"
}
}