Tổng quan/OpenAPI/Tạo và thu hồi

Tạo và thu hồi

Tải lên nguồn, tạo nội dung, và thu hồi tiến bộ, tín dụng và kết quả.

Tạo và thu hồi

Tất cả ba sản phẩm sử dụng một API Creations, vì vậy video, hình ảnh và kết quả ứng dụng chia sẻ cùng một danh sách, chi tiết và dòng công việc xuất.

Tải file nguồn

Tất cả các sản phẩm chấp nhận input_file_ids. Tải file đầu tiên:

curl -s "https://api.kpainter.ai/openapi/v1/files" \  -H "Authorization: Bearer $KPAINTER_API_KEY" \  -F "file=@./handbook.pdf"

Câu trả lời ví dụ:

{  "file_id": "file_xxx",  "name": "handbook.pdf",  "mime_type": "application/pdf",  "size_bytes": 248391}

Sử dụng file_id được trả lại chỉ trong các tác phẩm thuộc sở hữu của cùng một tài khoản.

Tạo

POST /creations

Các lĩnh vực chung:

Vùng cần thiết Ý nghĩa
loại Video, hình ảnh hoặc ứng dụng
nhanh chóng Làm gì để tạo
hướng dẫn Không Yêu cầu bổ sung
Nhập_file_ids Không ID nguồn đã tải lên trước đây
Max - tín dụng Không Số tín dụng tối đa cho nhiệm vụ này
Video / hình ảnh / app Đúng một thiết lập đối tượng phù hợp loại

Ví dụ :

{  "type": "app",  "prompt": "Build a safety quiz with immediate feedback from the handbook",  "input_file_ids": ["file_xxx"],  "app": {    "language": "en"  }}

Danh sách và Get

GET /creations?page=1&page_size=20GET /creations?type=video&page=1&page_size=20GET /creations/{id}

Các lĩnh vực chi tiết hữu ích:

Vùng Ý nghĩa
trạng thái kế hoạch, sản xuất, nghỉ ngơi, sẵn sàng hoặc thất bại
tiến bộ / pct Tăng tiến monoton từ 0 đến 100
Đánh giá_reamining_seconds Chỉ có khi đáng tin cậy
Đánh giá - Credit Dự báo hiện tại cho nhiệm vụ này
Real - tín dụng Net credits cho một nhiệm vụ thành công
đã_usable_delivery Có kết quả sử dụng đã tồn tại
Tính năng_Actions Các hành động hiện đang an toàn để gọi
Đánh giá An An Safe Explainer Video outline khi có sẵn
Kết quả_code Mã kết quả an toàn người dùng

Những thất bại thường xuyên bỏ qua các tín dụng thực tế. Một ETA không đáng tin cậy bị bỏ qua thay vì đoán.

Đọc kết quả

GET /creations/{id}/outputs

Hiển thị chỉ trả về các kết quả. Đừng chỉ ra một URL hoặc sử dụng một tác phẩm trung gian chưa hoàn thành.

Một dòng khách hàng ổn định

  1. Đọc kỹ năng
  2. Gửi một yêu cầu sáng tạo hợp lệ.
  3. Hãy tạo ra cùng một sáng tạo mỗi vài giây.
  4. Đọc kết quả sau khi sẵn sàng
  5. Nếu nghỉ ngơi, hiển thị các hành động có sẵn và chờ hành động người dùng cần thiết.
  6. Nếu thất bại, hiển thị lý do an toàn và cho phép người dùng xem lại yêu cầu.
  7. Nếu trạng thái mạng không chắc chắn, hãy nhận được sự sáng tạo hiện có trước khi tạo ra một thứ khác.