Tổng quan/OpenAPI/Tổng quan

Tổng quan

Tìm hiểu làm thế nào để đưa sáng tạo KPainter vào sản phẩm của bạn.

Nhập KPainter vào sản phẩm của bạn

KPainter OpenAPI dành cho những nhà phát triển muốn tạo nội dung trong sản phẩm, tự động hóa hoặc dòng công việc của các đại lý. Nó trình bày ba sản phẩm công cộng:

Sản phẩm loại Tốt nhất cho
Video giải thích Video các khóa học, đào tạo, SOP, tổng kết nghiên cứu, giáo dục sản phẩm, và giải thích kiến thức
Hình ảnh AI Hình ảnh poster, cover, minh họa, và khái niệm hình ảnh duy nhất
Ứng dụng AI app ứng dụng Các trang tương tác, mô phỏng, quiz và các công cụ nhỏ

PDF, bản trình bày, tài liệu và hình ảnh là tài liệu nguồn; chúng không chọn sản phẩm xuất. Explainer Video cũng có thể sử dụng URL của trang web như là bối cảnh nguồn.

Cơ sở URL

Tất cả các yêu cầu sản xuất bắt đầu từ đây:

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

Ví dụ, điểm kết thúc toàn bộ khả năng là:

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

Một dòng chảy sáng tạo đầy đủ

  1. Hãy gọi GET /me để xác minh khóa API.
  2. Hãy gọi GET /capabilities để khám phá các tùy chọn hiện tại.
  3. Tải lên các phụ kiện với POST /file.
  4. Tạo một video, hình ảnh hoặc ứng dụng với POST /creations.
  5. Poll GET /creations/{id} cho trạng thái và tiến bộ.
  6. Đọc GET /creations/{id}/outputs khi giao hàng có sẵn.
  7. Sử dụng tin nhắn để làm rõ một Video Explainer. Khi một nhiệm vụ dừng lại, chỉ thực hiện một hành động được liệt kê trong các hành động có sẵn.

điểm cuối chính

Kết thúc mục đích
Chăm sóc sức khỏe / Health Kiểm tra khả năng dịch vụ
GET / Tôi Kiểm tra tài khoản hiện tại
Khả năng / Capacities Khám phá các sản phẩm, thông số, mẫu và mô hình
Bài viết / file tải file input
Post / Tạo Tạo nội dung
Tạo / Creations Danh sách các tác phẩm của tài khoản
GET / sáng tạo /{id} Đọc trạng thái, tiến bộ, ETA, tín dụng, và đánh giá
POST /các tác phẩm /{id}/Những tin nhắn Tải lại một Video Explainer
POST /Các sáng tạo /{id}/Các hành động Tiếp tục công việc nghỉ ngơi mới nhất
GET /creations/{id}/outputs Đọc các kết quả được phê duyệt QA

Những gì để giữ trong tâm trí

  • Tính xác thực với một Key API Bearer.
  • Các trường yêu cầu công cộng và câu trả lời sử dụng snake_case.
  • Gửi chỉ các giá trị thông số được trả lại bởi khả năng.
  • Một thất bại thông thường không báo cáo tín dụng thực tế.
  • ETA bị bỏ qua khi nó không thể được ước tính đáng tin cậy.
  • Đọc các kết quả có thể sử dụng từ điểm kết thúc xuất khẩu sau khi hoàn thành thay vì xây dựng URL lưu trữ.