Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ส่งงานสร้างวิดีโอ

เซิร์ฟเวอร์:https://openapi.felo.ai
ไลบรารีไคลเอนต์

ส่งงานสร้างวิดีโอ

​

สร้างงานสำหรับสร้างวิดีโอแบบอะซิงโครนัสและคืนค่า task_id ทันที (HTTP 202) ให้เรียก GET /api/v1/videos/generations/{task_id} ซ้ำจนกว่าจะสำเร็จ บอดี้คำขอส่งได้ทั้งแบบแบน ({model, prompt, ...}) หรือแบบซ้อน ({model, input: {prompt, ...}}) โดยออบเจ็กต์ input จะมีผลเหนือกว่าเมื่อมีอยู่ ฟิลด์ callback (callBackUrl / callback_url / callbackUrl) จะถูกละเว้น

มีโหมดอินพุตสามแบบที่ใช้ร่วมกันไม่ได้:

  • text-to-video: ใช้เฉพาะ prompt;
  • image-to-video (เฟรมแรก/เฟรมสุดท้าย): first_frame_url (+ last_frame_url ซึ่งไม่บังคับ);
  • omni-reference: reference_image_urls / reference_video_urls / reference_audio_urls การผสมเฟรมแรก/เฟรมสุดท้ายกับอินพุตอ้างอิงแบบมัลติโมดัลใด ๆ จะคืนค่า 400 invalid_request_error
เฮดเดอร์
  • X-Request-Id
    ประเภท: string

    ID คำขอจากผู้เรียกซึ่งไม่บังคับ ระบบจะสะท้อนกลับมาเพื่อการวินิจฉัย

  • X-Felo-Channel
    ประเภท: string

    รหัสช่องทางสาธารณะที่คั่นด้วยเครื่องหมายจุลภาคตามลำดับ หากไม่ส่งเฮดเดอร์นี้จะใช้ default โดยต้องใช้ default เดี่ยว ๆ เท่านั้น ในโหมดกระเป๋าเงิน default จะสแกนลำดับช่องทางสาธารณะที่มีผลของโมเดลจากท้ายไปต้น ข้ามช่องทางที่ยังไม่เผยแพร่หรือไม่พร้อมใช้งาน และเลือกผู้ให้บริการของช่องทางแรกที่พร้อมใช้งาน โดยจะรวม endpoint ที่พร้อมใช้งานของผู้ให้บริการรายนั้นที่มี upstream model ID และระดับบริการเดียวกัน ช่องทางที่ระบุอย่างชัดเจนจะถูกตรวจสอบตามลำดับที่ไคลเอนต์กำหนด และส่งเฉพาะกลุ่มผู้ให้บริการของช่องทางแรกเท่านั้น ไม่มีการสลับไปยังผู้ให้บริการรายอื่นโดยอัตโนมัติ เฮดเดอร์ผู้ให้บริการแบบเดิมไม่สามารถแทนที่การกำหนดเส้นทางตามช่องทางได้

บอดี้·VideoGenerationRequest
จำเป็น
application/json

อินพุตสำหรับสร้างวิดีโอ ส่งได้ทั้งแบบแบน ({model, prompt, ...}) หรือแบบซ้อน ({model, input: {...}}) โดย input มีผลเหนือกว่า ต้องใช้โหมดอินพุตเพียงหนึ่งเดียวเท่านั้น การผสมเฟรมแรก/เฟรมสุดท้ายกับอินพุตอ้างอิงแบบมัลติโมดัลจะถูกปฏิเสธ

  • model
    ประเภท: string
    จำเป็น

    ชื่อโมเดลที่ใช้กับ Felo เช่น seedance-2.0-mini

  • aspect_ratio
    ประเภท: string enum
    ค่า
    • 16:9
    • 9:16
    • 1:1
    • 4:3
    • 3:4
    • 21:9
    • adaptive
  • duration
    ประเภท: integer
    ต่ำสุด:  
    4
    สูงสุด:  
    15

    Integer numbers.

  • first_frame_url
    ประเภท: string รูปแบบ: uri
  • generate_audio
    ประเภท: boolean
  • input
    ประเภท: object

    ออบเจ็กต์ input แบบซ้อนซึ่งไม่บังคับ เมื่อมีอยู่ ฟิลด์ภายในจะมีผลเหนือฟิลด์ข้างเคียง

    • aspect_ratio
      ประเภท: string enum

      อัตราส่วนภาพเอาต์พุต ค่า adaptive จะตามอัตราส่วนของรูปภาพอินพุต

      ค่า
      • 16:9
      • 9:16
      • 1:1
      • 4:3
      • 3:4
      • 21:9
      • adaptive
    • duration
      ประเภท: integer
      ต่ำสุด:  
      4
      สูงสุด:  
      15

      ระยะเวลาเอาต์พุตเป็นวินาที

    • first_frame_url
      ประเภท: string รูปแบบ: uri

      URL รูปภาพเฟรมแรก (โหมด image-to-video)

    • generate_audio
      ประเภท: boolean

      ระบุว่าจะสร้างแทร็กเสียงที่ซิงค์กันหรือไม่

    • last_frame_url
      ประเภท: string รูปแบบ: uri

      URL รูปภาพเฟรมสุดท้าย ต้องใช้ร่วมกับ first_frame_url

    • prompt
      ประเภท: string
      ความยาวสูงสุด:  
      2000

      พรอมต์ จำเป็นสำหรับโหมด text-to-video และ omni-reference

    • reference_audio_urls
      ประเภท: array string[] …3รูปแบบ: uri

      คลิปเสียงอ้างอิงแบบ omni-reference

    • reference_image_urls
      ประเภท: array string[] …9รูปแบบ: uri

      รูปภาพอ้างอิงแบบ omni-reference ใช้ร่วมกับเฟรมแรก/เฟรมสุดท้ายไม่ได้

    • reference_video_urls
      ประเภท: array string[] …3รูปแบบ: uri

      วิดีโออ้างอิงแบบ omni-reference ใช้ร่วมกับเฟรมแรก/เฟรมสุดท้ายไม่ได้ การส่งวิดีโอจะเปลี่ยนราคาต่อหน่วยที่เรียกเก็บเงินและเพิ่มระยะเวลาอินพุตเข้าไปในจำนวนโทเคน

    • resolution
      ประเภท: string enum

      ความละเอียดเอาต์พุต ความละเอียดที่สูงขึ้นใช้โทเคนมากขึ้นและมีค่าใช้จ่ายสูงขึ้น

      ค่า
      • 480p
      • 720p
      • 1080p
      • 4k
    • service_tier
      ประเภท: string | null

      ขณะนี้รองรับเฉพาะ default (standard) เท่านั้น ค่าที่ไม่ระบุ ค่า null ชื่อแทน และสตริงที่ไม่รองรับจะถูกแทนด้วย default ส่วนประเภทอื่นจะคืน HTTP 400 ช่องทางและราคาที่กำหนดค่าไว้ยังคงเดิม API ข้อความจะส่งค่ามาตรฐานของผู้ให้บริการ ส่วน Decisions และ API การสร้างผลงานจะไม่ส่งฟิลด์ต้นทางนี้

  • last_frame_url
    ประเภท: string รูปแบบ: uri
  • prompt
    ประเภท: string
    ความยาวสูงสุด:  
    2000
  • reference_audio_urls
    ประเภท: array string[] …3รูปแบบ: uri
  • reference_image_urls
    ประเภท: array string[] …9รูปแบบ: uri
  • reference_video_urls
    ประเภท: array string[] …3รูปแบบ: uri
  • resolution
    ประเภท: string enum
    ค่า
    • 480p
    • 720p
    • 1080p
    • 4k
  • service_tier
    ประเภท: string | null

    ขณะนี้รองรับเฉพาะ default (standard) เท่านั้น ค่าที่ไม่ระบุ ค่า null ชื่อแทน และสตริงที่ไม่รองรับจะถูกแทนด้วย default ส่วนประเภทอื่นจะคืน HTTP 400 ช่องทางและราคาที่กำหนดค่าไว้ยังคงเดิม API ข้อความจะส่งค่ามาตรฐานของผู้ให้บริการ ส่วน Decisions และ API การสร้างผลงานจะไม่ส่งฟิลด์ต้นทางนี้

การตอบกลับ
  • 202
    ประเภท: object · VideoGenerationAccepted

    รับงานแล้ว

    • kind
      enum
      const:  
      video
      จำเป็น
      ค่า
      • video
    • outputs
      ประเภท: array string[]
      จำเป็น

      ว่างจนกว่างานจะสำเร็จ

    • status
      enum
      const:  
      queued
      จำเป็น
      ค่า
      • queued
    • task_id
      ประเภท: string
      จำเป็น

      ID ของงานที่ใช้สำหรับตรวจสอบสถานะ

    application/json
  • 400
    ประเภท: object · GenerationError

    คำขอไม่ถูกต้อง (ไม่รู้จักโมเดล โหมดอินพุตปนกัน หรือฟิลด์ไม่ถูกต้อง)

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 401
    ประเภท: object · GenerationError

    คีย์ API ของ Felo ไม่ถูกต้องหรือไม่มี

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 402
    ประเภท: object · GenerationError

    ยอดคงเหลือไม่เพียงพอ / ไม่ตรงตามเงื่อนไขการเรียกเก็บเงิน

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 403
    ประเภท: object · GenerationError

    บัญชีไม่ได้รับอนุญาต (ต้องสมัครสมาชิกหรือผู้ใช้ถูกระงับ) โมเดลที่ปิดใช้งานจะถูกปฏิเสธก่อนเรียกต้นทางเช่นกัน คำขอและงานที่รับไว้แล้วยังคงดำเนินการต่อ

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 429
    ประเภท: object · GenerationError

    ถึงขีดจำกัดคำขอหรือการใช้จ่ายแล้ว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 502
    ประเภท: object · GenerationError

    ผู้ให้บริการต้นทางล้มเหลว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 503
    ประเภท: object · GenerationError

    บริการสร้างผลงานหรือบริการเรียกเก็บเงินไม่พร้อมใช้งานชั่วคราว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
Request Example for post/api/v1/videos/generations
curl https://openapi.felo.ai/api/v1/videos/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "seedance-2.0-mini",
  "prompt": "a cinematic trailer shot, 720p",
  "resolution": "720p",
  "duration": 5,
  "generate_audio": true
}'
{
  "task_id": "string",
  "status": "queued",
  "kind": "video",
  "outputs": [
    "string"
  ]
}
Submit a video generation task