概要/OpenAPI/創造・取り戻し

創造・取り戻し

ソースをアップロードし、コンテンツを作成し、進歩、クレジット、および出力を取得します。

創造・復活

すべての3つの製品は1つの Creations API を使用するので、ビデオ、画像、アプリの結果は同じリスト、詳細、出力ワークフローを共有します。

ソースファイルのアップロード

すべての製品は input_file_ids を受け入れます。 ファイルを最初にアップロードする:

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

例の回答:

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

返却されたファイルID を使用するには、同じアカウントが所有する作成の内部のみ。

作成

POST /creations

共通のフィールド:

フィールド 必要 意味
タイプ はい ビデオ、画像、アプリ
早速 はい 何を作るか
指示 ノー 追加要件
入力_ファイル_ids ノー 以前アップロードされたソースID
マックス・クレジット ノー この課題に適用される最大クレジット
ビデオ / 画像 / アプリ はい 正確に 1 つの設定 オブジェクト 匹敵 タイプ

例:

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

リストと得る

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

役に立つ詳細:

フィールド 意味
地位 計画、生産、休憩、準備、または失敗
プロジェクト / PCT 0から100までのモノトニックな進歩
レミニング・セクンド / Seconds 信頼できる場合のみ
評価・信用 この課題に対する現在の推定
リアル・クレジット 成功した課題のための純クレジット
利用可能な配達 利用可能な結果が既に存在するか
アクション・アクション 現在安全に呼びかけている行動
レビュー 安全な説明ビデオの出力は、利用可能なときに
結果コード ユーザーセキュアな出力コード

通常の失敗は実際の信用を無視します。 信じられないETAは推測するよりも無視される。

結果を読む

GET /creations/{id}/outputs

表示は出力のみ返します。 URL を入力したり、未完成の中間アーティファクトを使用しないでください。

安定したクライアント流

  1. 能力を読む
  2. 1 有効な創造申請を提出します。
  3. 同じ創造を数秒ごとに実行します。
  4. 準備が整った後、出力を読む。
  5. 休憩した場合、利用可能なアクションを表示し、必要なユーザーアクションを待つ。
  6. 失敗した場合は、安全な理由を示し、ユーザーがリクエストを再検討することを許可します。
  7. ネットワーク状態が不確実である場合は、別の作成前に既存の作成を得る。