ภาพรวม/OpenAPI/ภาพรวม

ภาพรวม

เรียนรู้วิธีการนําการสร้าง KPainter ในผลิตภัณฑ์ของคุณ

นํา KPainter ในผลิตภัณฑ์ของคุณ

KPainter OpenAPI เป็นสําหรับนักพัฒนาที่ต้องการสร้างเนื้อหาภายในผลิตภัณฑ์ของตัวเองอัตโนมัติหรือกระบวนการทํางานของตัวแทน มันแสดงให้เห็น 3 ผลิตภัณฑ์สาธารณะ:

ผลิตภัณฑ์ ประเภท ดีที่สุดสำหรับ
วิดีโออธิบาย วิดีโอ หลักสูตรการฝึกอบรม SOPs, การวิจัยสรุปผลิตภัณฑ์การศึกษาและคําอธิบายความรู้
ภาพ AI รูปภาพ โพสต์เคลือบภาพและแนวคิดภาพเดียว
แอป AI แอป หน้าแบบโต้ตอบ simulations, quizzes และเครื่องมือขนาดเล็ก

PDFs, presentations, documents, and images are source material; พวกเขาไม่เลือกผลิตภัณฑ์ส่งออก วิดีโออธิบายยังสามารถใช้ URL ของหน้าเว็บเป็นพื้นฐาน

ฐาน URL

คําขอการผลิตทั้งหมดเริ่มต้นที่นี่:

https://api.kpainter.ai/openapi/v1

ตัวอย่างเช่นจุดสิ้นสุดของความสามารถเต็มรูปแบบคือ:

https://api.kpainter.ai/openapi/v1/capabilities

การสร้างที่สมบูรณ์แบบ

  1. Call GET /me เพื่อตรวจสอบคีย์ API
  2. Call GET /capabilities เพื่อค้นพบตัวเลือกปัจจุบัน
  3. ดาวน์โหลดไฟล์ที่แนบมาพร้อมกับ POST / ไฟล์
  4. สร้างวิดีโอรูปภาพหรือแอปด้วย POST /creations
  5. Poll GET /creations/{id} สําหรับสถานะและขั้นตอน
  6. อ่าน GET /creations/{id}/outputs เมื่อการจัดส่งที่มีอยู่
  7. ใช้ข้อความเพื่อปรับปรุงวิดีโออธิบาย เมื่องานหยุดทํางานให้ดําเนินการเพียงการดําเนินการที่ระบุไว้ในกิจกรรมที่มีอยู่

จุดสิ้นสุดหลัก

จุดสิ้นสุด เป้าหมาย
รับ / สุภาพ ตรวจสอบการให้บริการ
รับ / ฉัน ตรวจสอบบัญชีปัจจุบัน
รับ / ความสามารถ ค้นพบผลิตภัณฑ์พารามิเตอร์รูปแบบและรูปแบบ
โพสต์ / ไฟล์ ดาวน์โหลดไฟล์ input
โพสต์ / การสร้าง สร้างเนื้อหา
รับ / การสร้าง รายการการสร้างบัญชี
GET / การสร้าง /{id} อ่านสถานะ, การพัฒนา, ETA, โคตรและรีวิว
โพสต์ / การสร้าง / {id} / ข้อความ วิดีโอการอธิบาย
โพสต์ / การสร้าง / {id} / การกระทํา ปฏิบัติตามงานหยุดล่าสุด
GET /การสร้าง /{id} / outputs อ่านผลลัพธ์ที่ได้รับการอนุมัติ QA

สิ่งที่ต้องเก็บไว้ในใจ

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