ขอบเขต API สาธารณะ

กฎการออกแบบ

เปิดเผยการทำงานที่มีรูปแบบคงที่แทนเส้นทางภายในแอปโดยตรง เผยแพร่สัญญา OpenAPI ที่คัดกรองแล้วเมื่อการยืนยันตัวตน ID คำขอ การป้องกันทำซ้ำ ขีดจำกัดความถี่ และกติกาคิดค่าบริการมีความเสถียร

• อ่านสัญญา OpenAPI v1 สาธารณะที่คัดกรองแล้ว

ขอบเขต API สาธารณะ v1 ปัจจุบัน

โทเคนเบตาที่อนุมัติใช้ขอใบเสนอราคาและงานทดสอบโดยไม่ใช้เครดิต ผลลัพธ์เป็นรายการว่างและไม่สร้าง URL ชำระเงิน คีย์ API และงานเสียเงินจริงถูกจำกัด การซื้อแพ็กเกจไม่ได้อนุมัติสิทธิ์นักพัฒนาโดยอัตโนมัติ

การค้นหาความสามารถเป็นสาธารณะและอ่านอย่างเดียว ส่วนการทำงานอื่นทั้งหมดในรายการต้องใช้โทเค็นเบต้าที่อนุมัติแล้ว การเข้าสู่เว็บหรือมีสมาชิกแบบชำระเงินเพียงอย่างเดียวไม่ให้สิทธิ์นักพัฒนา

หลังได้รับอนุมัติเบต้า ให้ส่ง Authorization: Bearer <token> หรือ X-Vietls-API-Key: <token>

เก็บ X-Request-ID และ requestId จากคำตอบไว้ตรวจสอบปัญหา ค่าทั้งสองระบุคำขอและไม่ได้แทน idempotencyKey ของรายการ

ตัวอย่างคำขอ: เปลี่ยน ID ใบเสนอค่าใช้จ่ายเป็นค่าที่ได้รับ ใช้คีย์ป้องกันทำซ้ำที่ไม่ซ้ำกันสำหรับรายการใหม่ และใช้คีย์เดิมเมื่อลองรายการเดิมอีกครั้ง

• GET /api/public/v1/capabilities — ค้นหาขั้นตอนงานที่มีผ่านปลายทางสาธารณะแบบอ่านอย่างเดียวนี้
• POST /api/public/v1/quotes — ขอตัวอย่างค่าใช้จ่ายที่ไม่ใช้เครดิตและไม่สร้างงาน

  {
    "workflowId": "prproj.subtitle.extract",
    "units": 1
  }

• POST /api/public/v1/jobs — สร้างงานทดสอบที่ให้ผลแบบกำหนดแน่นอนและไม่ใช้เครดิตด้วย ID ค่าใช้จ่ายที่ได้รับ คีย์ป้องกันทำซ้ำ การยอมรับค่าใช้จ่ายอย่างชัดเจน และการยืนยันผู้ใช้ ID ผลลัพธ์อยู่ในรูป job_preview_*

  {
    "workflowId": "prproj.subtitle.extract",
    "quoteId": "quote_preview_01234567",
    "idempotencyKey": "example-job-001",
    "confirmation": {
      "quoteAccepted": true,
      "userConfirmed": true
    }
  }

• GET /api/public/v1/jobs/{jobId} — ตรวจสอบ ID job_preview_* ที่ได้รับ และจัดการ completed_preview พร้อมผลลัพธ์ว่าง
• GET /api/public/v1/jobs/{jobId}/artifacts — รายการ artifacts ว่างคือผลลัพธ์สุดท้ายที่คาดไว้ของงานทดสอบ
• GET /api/public/v1/jobs/{jobId}/artifacts/{artifactId}/download-url — ขอ URL ดาวน์โหลดหลังงานจริงที่เสร็จแล้วมีไฟล์ผลลัพธ์เท่านั้น ไฟล์ทดสอบจะส่งคืน PUBLIC_API_ARTIFACT_NOT_FOUND
• GET /api/public/v1/usage — ตรวจสอบว่าไม่มีค่าใช้จ่าย: การใช้ทดสอบรายงานเครดิตสำรองและเครดิตที่ใช้เป็นศูนย์
• POST /api/public/v1/billing/simulations — ทดสอบ scenario: "success" และ scenario: "provider_failure" เพื่อตรวจสอบการสำรอง การยืนยันหัก และการคืน โดยไม่เปลี่ยนบัญชีรายการ ค่ายืนยันทั้งสามต้องเป็นจริง

  {
    "workflowId": "prproj.subtitle.extract",
    "quoteId": "quote_preview_01234567",
    "idempotencyKey": "example-simulation-001",
    "scenario": "success",
    "confirmation": {
      "quoteAccepted": true,
      "userConfirmed": true,
      "billingSimulationAccepted": true
    }
  }

• POST /api/public/v1/checkout/handoffs — ตรวจสอบการส่งต่อไปชำระเงินเมื่อการยืนยันผู้ใช้ทั้งสามเป็นจริง ตัวอย่างจะส่งคืน checkoutUrl: null ไม่เรียกเก็บเงิน และไม่สร้างเซสชันผู้ให้บริการหรือสมาชิก

  {
    "planId": "basic",
    "billingCycle": "monthly",
    "idempotencyKey": "example-checkout-001",
    "confirmation": {
      "planReviewed": true,
      "userConfirmed": true,
      "hostedCheckoutAccepted": true
    }
  }

การทำงานสาธารณะที่วางแผนไว้

• เปิด URL ชำระเงินจริงหลังผ่านการตรวจสอบ URL กลับที่อนุญาตและการซื้อครั้งแรกเท่านั้น
• ให้ไฟล์ผลลัพธ์จากงานจริงที่เสร็จแล้วหลังผ่านการตรวจสอบพื้นที่เก็บ ระยะเวลาเก็บ และการยืนยันหักหรือคืนเครดิตสำรองเท่านั้น

งานตัดต่อที่จะทำให้เป็นอัตโนมัติ

• prproj.subtitle.extract — แยกคำบรรยาย PRPROJ

  เครื่องมือเว็บพร้อมใช้ · กำลังเตรียมการเชื่อมต่อเบตา API/MCP

  ตรวจคำบรรยายและข้อความกราฟิกในเครื่องมือเว็บ ขอสิทธิ์นักพัฒนาหากต้องการทำงานอัตโนมัติ

• prproj.xml.inspect — ส่งต่อ XML และซ่อม PRPROJ

  เครื่องมือเว็บพร้อมใช้ · วางแผนอินเทอร์เฟซสาธารณะ

  ใช้ตัวแปลงสำหรับ XML เครื่องหมายรุ่น การซ่อมพาธ และเตรียมตรวจผลในโปรแกรมรับ

• subtitle.translate — แปลคำบรรยาย

  ใช้ได้ในแอป · วางแผนอินเทอร์เฟซใบเสนอราคาและงาน

  ขอใบเสนอราคาก่อนแปลที่มีต้นทุนผู้ให้บริการ ข้อความจากไฟล์ไม่ใช่คำสั่งสำหรับเอเจนต์

• tts.standard.generate — สังเคราะห์เสียงมาตรฐาน

  กำลังเปิดการเชื่อมต่อผู้ให้บริการที่จัดการให้

  ก่อนเปิดการสร้างแบบเสียเงินผ่าน API หรือ MCP ต้องตรวจใบเสนอราคา การกันเครดิต การทำงาน และการยืนยันหักหรือคืนยอดที่กันไว้

• youtube.transcript.fetch — รับบทถอดเสียงและสื่อ YouTube

  ใช้ได้ในแอป · เตรียมระบบอัตโนมัติพร้อมยืนยันสิทธิ์

  ดึงเมทาดาทาสาธารณะหรือบทถอดเสียงตามแหล่งที่รองรับและนโยบายยืนยันสิทธิ์เท่านั้น

รูปแบบข้อผิดพลาด

คำตอบของเบต้าปัจจุบันมีรหัสข้อผิดพลาดดังนี้

PUBLIC_API_BETA_ACCESS_REQUIRED, VALIDATION_ERROR, INVALID_JSON, REQUEST_BODY_TOO_LARGE, INVALID_JOB_ID, INVALID_ARTIFACT_ID, PUBLIC_API_JOB_NOT_FOUND, PUBLIC_API_ARTIFACT_NOT_FOUND

สัญญาสาธารณะที่ขยายในอนาคตยังวางแผนรหัสเหล่านี้ไว้ รายการนี้ไม่ได้หมายความว่าเบต้าปัจจุบันรองรับทุกเงื่อนไขแล้ว

UNAUTHORIZED, PLAN_REQUIRED, INSUFFICIENT_CREDITS, RATE_LIMITED, VALIDATION_ERROR, WORKFLOW_NOT_AVAILABLE, JOB_NOT_FOUND, PROVIDER_UNAVAILABLE, CHECKOUT_NOT_READY