API キータスク

タスク

非同期処理の結果を取得します。すべての作成系エンドポイント (notes、flashcards、 quiz、mindmap、slide、podcast、shorts、translate)は非同期で動作し、 task_id を返します。 このエンドポイントを使用して処理結果を確認します。

API Key(X-API-Key または Authorization: Bearer ntx_...)、User JWT、 または Service Key に対応しています。

Base URL: https://api.notexapp.com

タスク結果を取得 — GET /v1/create/tasks/{task_id}/result

ParameterInRequiredDescription
task_idpathrequired作成系エンドポイントから返されるタスク ID
curl https://api.notexapp.com/v1/create/tasks/<task_id>/result \
  -H "X-API-Key: ntx_live_..."

Responses

処理中:

{ "status": "PROCESSING" }

正常に完了:

{
  "status": "SUCCESS",
  "data": {
    "note_id": "665f...",
    "title": "Introduction to Machine Learning",
    "summary": "..."
  }
}

失敗:

{
  "status": "FAILURE",
  "error": "Unsupported file format"
}

ポーリングのガイド

  • 推奨間隔: 3~5秒 ごと。
  • ほとんどの処理は、元データの長さに応じて 30~120秒 で完了します。
  • statusSUCCESS または FAILURE になったらポーリングを停止してください。

ステータス一覧

StatusMeaning
PENDINGタスクはキューに登録済みで、まだ開始されていません
PROCESSINGタスクを実行中
SUCCESSタスク完了 — 結果は data にあります
FAILUREタスク失敗 — 理由は error にあります