Skip to main content
Producer Tasks API の主要機能は、Producer Audios Generation API 生成のタスクIDを入力することで、そのタスクの実行状況を照会することです。 本ドキュメントでは、Producer Tasks API の対接説明を詳しく紹介し、簡単に統合し、この API の強力な機能を十分に活用できるようにします。Producer Tasks API を使用することで、Producer Audios Generation API のタスク実行状況を簡単に照会できます。

申請プロセス

Producer Tasks API を使用するには、まず申請ページ Producer Audios Generation API で該当するサービスを申請し、その後、Producer Audios Generation API のタスクIDをコピーします。以下の図のように:

最後に、Tasks API ページ Producer Tasks API にアクセスし、該当するサービスを申請します。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように: 申請ページ まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後は、自動的に現在のページに戻ります。 初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

リクエスト例

Producer Tasks API は、Producer Audios Generation API の結果を照会するために使用できます。Producer Audios Generation API の使用方法については、ドキュメント Producer Audios Generation API を参照してください。 Producer Audios Generation API サービスから返されたタスクIDを例に、どのようにこの API を使用するかを示します。仮にタスクIDが:1a6ac2ad-10f2-4e2b-b500-66ec27fe82ad だとします。次に、タスクIDを渡す方法を示します。

タスク例図

リクエストヘッダーとリクエストボディの設定

Request Headers には以下が含まれます:
  • accept:JSON形式のレスポンス結果を受け取ることを指定します。ここには application/json を記入します。
  • authorization:APIを呼び出すためのキーで、申請後に直接ドロップダウンから選択できます。
Request Body には以下が含まれます:
  • id:アップロードされたタスクID。
  • action:タスクの操作方法。
設定は以下の図のようにします:

コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように:

一部のコード例は以下の通りです:

CURL

レスポンス例

リクエストが成功すると、API はこのタスクの詳細情報を返します。例えば:
返却結果は複数のフィールドがあり、requestフィールドはタスクを開始する際のrequest bodyであり、responseフィールドはタスク完了後に返されるresponse bodyです。フィールドの説明は以下の通りです。
  • id、生成タスクのIDで、今回の生成タスクを一意に識別するために使用されます。
  • request、タスクのリクエスト情報を照会します。
  • response、タスクの返却情報を照会します。

バッチクエリ操作

これは複数のタスクIDに対してタスクの詳細を照会するもので、上記とは異なり、actionをretrieve_batchに設定する必要があります。 Request Body には以下が含まれます:
  • ids:アップロードされたタスクIDの配列。
  • action:タスクの操作方法。
設定は以下の図のようになります:

コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように:

一部のコード例は以下の通りです:

レスポンス例

リクエストが成功した後、APIは今回のすべてのバッチタスクの具体的な詳細情報を返します。例えば:

CURL

エラー処理

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば:
  • 400 token_mismatched:不正なリクエスト、パラメータが不足または無効な可能性があります。
  • 400 api_not_implemented:不正なリクエスト、パラメータが不足または無効な可能性があります。
  • 401 invalid_token:未認証、無効または不足している認証トークン。
  • 429 too_many_requests:リクエストが多すぎます、レート制限を超えました。
  • 500 api_error:内部サーバーエラー、サーバーで何かがうまくいきませんでした。

エラー応答の例

結論

この文書を通じて、Producer Tasks APIを使用して単一またはバッチタスクのすべての詳細情報を照会する方法を理解しました。この文書がAPIの接続と使用に役立つことを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。