NodaroAccount
Nodaro ドキュメント
ドキュメントノードリファレンスモデルテンプレートAI エージェント(MCP)開発者向けセルフホスティングリサーチ比較
ツールリファレンス

プロジェクトとワークフロー

AI アシスタントが Nodaro のワークフローを JSON で構築し、バージョンの確認で安全に編集し、エクスポートとインポートで移動して、mcp プロジェクトで実行できます。

プロジェクトとワークフローのツールを使うと、アシスタントは、エディターが保存するのと同じ形式で Nodaro のワークフローを構築できます。つまり、JSON のノードと接続です。アシスタントは、start_workflow_editor と get_node_skill で形式を学び、ワークフローを作成、編集します。そして、エクスポートとインポートでワークフローをプロジェクト間で移動し、実行します。アシスタントが作成または編集するワークフローはすべて mcp プロジェクトに置かれるため、自分のプロジェクトには手が加わりません。セッションのツールは、プロジェクト内の作成セッションを読み取り、整理します。

典型的なセッション

形式を学ぶ

start_workflow_editor を呼び出します。このツールは、ワークフローの JSON の構造、接続をつなぐルール、ノードタイプのカタログを返します。ワークフローに必要なノードタイプごとに get_node_skill を呼び出し、各ピッカーの有効な値は get_picker_catalog で取得します。

ワークフローを作成する

名前と、必要に応じて最初のノードと接続を指定して、create_workflow を呼び出します。作成したワークフローは、MCP のワークフローからエディターで開けます。

安全に編集する

get_workflow_json で現在のグラフを読み取ります。次に、読み取ったバージョンを付けて、update_workflow_json に delta を送ります。変更されるのは、指定したノードと接続だけです。

実行する

run_workflow を呼び出し、get_app_run で実行を追跡します。各ノードの結果は、ライブラリに保存されます。

start_workflow_editor

アシスタントがワークフローを構築または編集する前に読む、ガイドを返します。ガイドでは、ワークフローの JSON の構造、接続と入力をつなぐ際の決まり、update_workflow_json のルールを説明しています。また、すべての生成ノードの結果フィールドと、ノードタイプのカタログも記載しています。

権限:不要(常に表示されます)。クレジット:無料。

このツールにパラメーターはありません。何も変更しないので、何度でも呼び出せます。

get_node_skill

1 つのノードタイプについて、完全なガイドを返します。データフィールドとそのデフォルト値、使いどころ、よくある間違い、JSON の実例が含まれます。そのタイプのノードをワークフローに書き込む前に使います。

ガイドに書かれたクレジット料金は、ノードの定価です。実行に請求される料金は、list_models か GET /v1/nodes で確認してください。

権限:不要(常に表示されます)。クレジット:無料。

パラメーター型説明
node_typestring必須。start_workflow_editor に一覧表示される、ケバブケースのノードタイプです。たとえば generate-image、list、trim-video です。

戻り値:ノードのガイドです。不明なタイプを指定すると、有効なタイプの一覧とともにエラーが返されます。

get_picker_catalog

舞台設定、ムード、人物、レンズなどのピッカーノードについて、有効な値を返します。ピッカーは、接続先のノードのプロンプトにフレーズを追加します。そのため、ワークフローでは、カタログに実在する ID を使う必要があります。ピッカーの値をワークフローに書き込む前に、このツールを呼び出してください。

権限:不要(常に表示されます)。クレジット:無料。

パラメーター型説明
node_typestringケバブケースのピッカーのタイプです。たとえば setting です。省略すると、すべてのピッカーを一覧表示します。
detailstringcompact(デフォルト)は、id、label、category、term、icon、imageUrl を返します。full では、各選択肢の description と promptHint も加わります。promptHint は、選択肢がプロンプトに追加する完全なフレーズです。
categorystring単一ディメンションのピッカーで使います。1 つのカテゴリーの選択肢だけを返します。
fieldstringマルチディメンションのピッカーの、1 つのディメンションだけを返します。たとえば人物、スタイリング、フレーミングで使います。単一ディメンションのピッカーの追加設定も返せます。たとえば、トランジションとキャラクター FXの位置、長さ、強さや、キャラクターモーションの位置とペースです。

戻り値:node_type を指定しない場合は、すべてのピッカーの一覧です。各ピッカーの nodeType、label、kind(single か multi)、値のフィールド、optionCount、imageCount が含まれます。node_type を指定した場合は、そのピッカーの選択肢です。不明なタイプを指定すると、有効なタイプとともにエラーが返されます。

どの選択肢にも term があります。term は、whip pan left のように、プロンプトに書き込む短い専門的なフレーズです。label は表示専用です。auto や none のように何もしない選択肢では、term は空です。画像のある選択肢には、絶対 URL の imageUrl が付きます。この URL はそのまま表示し、ID から URL を組み立てないでください。人物とスタイリングは、sections も返します。sections はトピックを順に並べたもので、それぞれにラベル、フィールド、任意の画像があります。

{
  "nodeType": "person",
  "sections": [
    { "label": "Identity", "fields": ["type", "age", "ethnicity", "regionalAesthetic"],
      "imageUrl": "https://app.nodaro.ai/picker-art/character/sections/identity.2d5ec1a4.webp" }
  ],
  "dimensions": [
    { "field": "type", "label": "Type", "options": [
      { "id": "man", "label": "Man", "term": "man",
        "imageUrl": "https://app.nodaro.ai/picker-art/character/person/man.d6bed999.webp" }
    ] }
  ]
}

ルックのピッカーの画像は、Nodaro Cloud でのみ返されます。独自の画像を表示するデプロイメントでは、オプションの imageUrl はそのデプロイメントの画像で、そのデプロイメント自身のメディアホストにあります。画像が付くのは、デプロイメントが画像を設定したオプションだけで、トピックには付きません。このツールは、拡大画像の imageLargeUrl を返しません。開発者向けの同じデータは、ピッカーカタログで説明しています。

list_projects

アカウント内のすべてのプロジェクトを、名前順に一覧表示します。各プロジェクトの ID、名前、説明、ワークフローの数、作成日が含まれます。アシスタントはすべてのプロジェクトを読み取れますが、編集できるのは mcp プロジェクトだけです。

権限:workflows:read。クレジット:無料。

このツールにパラメーターはありません。

戻り値:プロジェクトの一覧である data です。

get_project

ID または名前で指定した、1 つのプロジェクトを返します。

権限:workflows:read。クレジット:無料。

パラメーター型説明
project_idstring必須。プロジェクトの ID または名前です。名前は、大文字と小文字も含めて完全に一致する必要があります。たとえば My Feature Film です。

戻り値:プロジェクトの ID、名前、説明、ワークフローの数、作成日です。

list_workflows

mcp プロジェクト内のワークフローを、新しい順に一覧表示します。

権限:workflows:read。クレジット:無料。

パラメーター型説明
limitinteger1〜100 です。デフォルトは 20 です。
cursorstring前のページの next_cursor です。
include_sub_workflowsbooleanデフォルトは false です。この場合、エディターのプロジェクト表示と同じように、別のワークフローに属するサブワークフローは表示されません。サブワークフローも一覧表示するには、true を渡します。

戻り値:data と next_cursor です。data には、各ワークフローの ID、名前、説明、バージョン、サムネイル、日付、editorUrl が含まれます。next_cursor が null の場合は、最後のページです。

get_workflow

mcp プロジェクト内の 1 つのワークフローについて、詳細を返します。名前、説明、バージョン、日付です。

権限:workflows:read。クレジット:無料。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。

戻り値:ワークフローと、その editorUrl です。

get_workflow_json

mcp プロジェクト内のワークフローについて、グラフ全体を返します。ノード、接続、設定、名前、updated_at、version です。

権限:workflows:read。クレジット:無料。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。

戻り値:グラフと、ワークフローの editorUrl です。version を保持し、次の変更と一緒に送り返してください。そうすれば、ほかの人の編集を上書きする代わりに、変更が失敗します。

create_workflow

mcp プロジェクトにワークフローを作成します。空のワークフローも、最初のグラフを含むワークフローも作成できます。

権限:workflows:write。クレジット:無料。

パラメーター型説明
namestring必須。1〜200 文字です。
descriptionstring最大 2,000 文字です。
nodesarray最初のノードです。エディターのノード形式で指定します。
edgesarray最初の接続です。
settingsobjectワークフローの設定です。

戻り値:新しいワークフローの id、name、editorUrl です。editorUrl は、接続しているデプロイメントのエディターでワークフローを開くリンクです。リンクは返されたまま共有してください。モデルが対応していない設定は修正され、接続はチェックされます。詳しくは update_workflow_json を参照してください。

update_workflow_json

mcp プロジェクト内のワークフローの、グラフ、設定、サムネイルを変更します。workflow_id 以外のフィールドはすべて任意なので、たとえばサムネイルだけを変更することもできます。

権限:workflows:write。クレジット:無料。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。
deltaobject部分的な変更です。delta.base_version に対して、1 回の操作として適用されます。推奨される編集方法です。下記を参照してください。
nodesarrayすべてのノードを置き換えます。edges と一緒に送ります。
edgesarrayすべての接続を置き換えます。nodes と一緒に送ります。
settingsobjectワークフローの設定全体を置き換えます。ほかの書き手が所有する保存済みのキーは、変更せずに戻す必要があります。ほかの書き手が所有する設定のキーを参照してください。
thumbnail_urlstring または nullすでにホストされている画像の URL です。サムネイルを削除するには、null を指定します。
expected_versionintegerget_workflow_json で取得した version です。その後ワークフローが変更されていた場合、変更は拒否されます。
expected_updated_atstringget_workflow_json で取得した updated_at です。同じ確認を行う、以前からの方法です。expected_version を使うことをおすすめします。

戻り値:ノードの数とワークフローの editorUrl を含む確認メッセージと、Nodaro が修正した設定の一覧です。

delta で編集する

delta では、変更するものだけを ID で指定します。nodes、edges、settings、thumbnail_url、expected_ で始まるフィールドとは組み合わせられません。

delta のフィールド動作
base_version必須。get_workflow_json で取得した version です。その後ワークフローが変更されていた場合、変更は拒否されます。
upsert_nodes追加または置き換えるノード全体です。ID で照合されます。
delete_node_ids削除するノードです。その接続も削除されます。
upsert_edges追加または置き換える接続全体です。ID で照合されます。
delete_edge_ids削除する接続です。
set新しい name、またはキーごとにマージされる settings です。送ったキーは保存済みのキーを置き換え、省略したキーはそのまま残ります。

グラフ全体を送るより、delta を使ってください。古いコピーをもとにグラフ全体を書き込むと、その間に別のセッションが行った変更が消えてしまいます。

Nodaro がチェックする接続

書き込みのたびに、接続がチェックされます。対象は create_workflow、update_workflow_json、import_workflow で、delta の upsert_edges も含みます。delta の接続は、delta を適用した後のグラフに対してチェックされます。

  • 古い入力名や出力名は、現在の名前に移されます。たとえば、Telegram チャンネルフィードノードの out は text になります。
  • id のない接続には、id が付けられます。
  • 機能しない接続は削除されます。存在しないノードを指す接続、ノードを自分自身につなぐ接続、端が欠けている接続です。id なしで 2 回送られた同じ接続も削除されます。編集リスト(EDL)をトランスクリプトの入力につないだ接続も削除され、トランスクリプトを edl 入力につないだ接続も同じです。
  • ノードにない入力名や出力名は、送られたまま保存され、警告が出ます。キャンバスは、ノードに表示される入力と出力にだけ接続を描きます。各ノードの名前は get_node_skill で確認してください。

応答には、すべての変更が一覧表示されます。構造化された結果には、変更が edgeAdjustments として、警告が edgeWarnings として含まれます。同じ id の接続が 2 つあると、書き込み全体が拒否され、何も保存されません。

新しいノードは、デプロイメントが提供するモデルで始まります

モデルを制限しているデプロイメントでは、create_workflow、update_workflow_json、import_workflow が、ワークフローに新しく加わる各ノードを確認します。そのノードがモデルを指定しておらず、デフォルトのモデルが提供されていない場合、そのノードは、エディターのメニューに表示されるモデルのうち、アカウントで実行できる最初のモデルで書き込まれます。エディターで新しいノードを作るときと同じです。

  • 指定したモデルはそのまま残ります。 そのモデルが提供されていない環境では、実行時に拒否されます。
  • ワークフローにすでにあるノードは、そのモデルのままです。
  • 変更はそれぞれ一覧にされます。 応答と structuredContent.modelMoves に、nodeId、type、field、from、to 付きで示されます。

モデルを制限していないデプロイメントは、すべてのノードを送られたとおりに保存します。

その間にワークフローが変更された場合

expected_version、expected_updated_at、または delta を使う場合、読み取った後にワークフローが変更されていると、競合が返されます。メッセージは「Workflow was modified since you last read it. Fetch the latest JSON with get_workflow_json and retry.」(前回の読み取りの後にワークフローが変更されました。get_workflow_json で最新の JSON を取得し、やり直してください)です。ワークフローを読み取り直し、変更をやり直してください。これらのフィールドがない場合、書き込みは無条件にワークフローを上書きします。

モデルが対応していない設定

画像ノードは、aspectRatio、resolution、quality などのモデル固有の設定を受け付けます。使える値は、モデルごとに異なります。モデルが受け付けない値をノードが指定していても、Nodaro は書き込みを拒否しません。値をモデルが対応している値に変更するか、モデルにその設定がない場合は削除します。そして、応答に次のように各変更を一覧表示します。

Updated workflow 4f0c… (12 nodes).

Adjusted 2 parameter(s) the selected model does not accept:
  - node_8 (gpt-image): aspectRatio "16:9" → "1:1" — GPT Image 1.5 does not
    support aspect_ratio "16:9". Supported: 1:1, 3:2, 2:3.
  - node_8 (gpt-image): resolution "2K" → removed — GPT Image 1.5 has no
    resolution setting.

構造化された結果には、同じ一覧が adjustments として含まれます。保存された値は送った値とは異なるので、元の値を送り直さないでください。各モデルで使える値は list_models で確認するか、必要な設定に対応したモデルを選んでください。create_workflow と import_workflow も、同じように設定を修正します。複数のモデルが同時に設定されたノードは、そのまま残ります。

修正されずに残る値が 1 つあります。画像生成、画像から画像、画像修正、画像を編集ノードの aspectRatio: "auto" です。自動は、写真の形を保ちます。ワークフローの実行時に、形を保つ独自の auto 設定を持つモデルはそれを受け取ります。それ以外のモデルは写真に最も近い対応アスペクト比を使い、GPT Image 2.6 も同じです。その独自の auto は縦長の正方形に近い形で生成されるためです。画像生成ノードでは、写真とはノードがモデルに送る最初の画像です。インペイントまたはリファインの画像、なければ最初のリファレンス画像です。写真が接続されていない場合、auto はモデルのデフォルトの形になります。モデルに独自の auto があればそれ、なければ最初に記載された比率です。

動画ノードの Seedance のリファレンスタスクタイプ、つまり generate-video、image-to-video、text-to-video、video-to-video ノードの referenceTaskType は、ノードで実行するモデルがその値を挙げている間だけ残ります。現在そのモデルは Seedance 2.5 と Seedance 2.5 Flash で、list_models はその値を referenceTaskTypes として一覧にします。複数のモデルを持つノードでは、そのうち 1 つで足ります。それ以外の場合はキーが削除されて adjustments に記載されるので、値が別のモデルで使われないまま残り、あとで効果を持つことはありません。auto と、どのモデルも挙げていない値も削除されます。自動は、キーが設定されていないことを意味します。モデルを指定していないノードは、デフォルトで実行するモデルで判断されます。

プロンプトの前後のテキスト

どの AI ノードの data にも、promptPrefix と promptSuffix を含められます。これは、ノードの実行時に Nodaro がプロンプトの前後に追加するテキストです。プロンプトの前後のテキストを参照してください。

ほかの書き手が所有する設定のキー

ワークフローの settings は複数の書き手が共有しており、本文全体の settings はそれを丸ごと置き換えます。保存済みの次の 3 つのキーは、変更できません。

  • settings.studio:このキーがあるワークフローはスタジオプロダクションで、ショット、結果、プランがここに入っています。プロダクションを変更するには、スタジオプロダクションのツールを使います。
  • settings.mcpConversation:アシスタントが MCP で作ったワークフローです。どのチャットがワークフローを作り、どこまで進んだかを記録します。Nodaro は、チャットを続けるときと一覧にするときに、これを読みます。MCP の会話はワークフローになりますを参照してください。
  • settings.mcpHub:その月の会話をまとめるハブの、月の目印です。

これらのキーを変更または削除する本文全体の settings は拒否されます。get_workflow_json で取得した値をそのままコピーするか、settings を省略してください。本文全体の settings は、常に読み取ったときのバージョンに対して書き込まれ、自分で指定した expected_version や expected_updated_at は一致の条件をさらに絞るだけです。その間に変更されたワークフローは、古い expected_version と同じ競合を返します。アシスタントの会話の記録は、ステップごとに変わります。ワークフローを読み直して、再試行してください。

delta.set.settings はキーごとにマージされるので、省略したキーはそのまま残ります。そこで拒否されるのは、所有されたキーを変更して送った場合か、null として送った場合だけです。

delete_workflow

mcp プロジェクトからワークフローを削除します。削除は元に戻せません。

権限:workflows:write。クレジット:無料。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。

戻り値:確認メッセージです。ワークフローが mcp プロジェクトにない場合は、エラーが返されます。

export_workflow

どのプロジェクトにあるワークフローでも、自分のワークフローなら、持ち運べる JSON バンドルとしてエクスポートします。mcp プロジェクトに限定されないワークフローツールは、これだけです。

権限:workflows:read。クレジット:無料。

パラメーター型説明
workflow_idstring必須。自分のワークフローであれば、どれでも指定できます。
with_assetsbooleanデフォルトは false です。true にすると、ワークフローが使うキャラクター、オブジェクト、ロケーションもバンドルに含めます。

戻り値:JSON 文字列としてのバンドルです。この文字列全体を import_workflow に渡します。

モードバンドルの内容用途
テンプレート(with_assets: false)グラフのみ。アセット固有の内容は含みませんワークフローの構造を、再利用できるテンプレートとして共有する
フル(with_assets: true)グラフと、グラフが使うすべてのキャラクター、オブジェクト、ロケーション完成したプロダクションを、別のアカウントやインスタンスに移動する

ノードが、別のインスタンスからはダウンロードできないメディアを使っている場合があります。たとえば、セルフホスティング環境のローカルストレージにあるファイルです。その場合、バンドルは portability.unreachableMedia に、そのメディアをノード、フィールド、URL とともに一覧表示します。バンドルはそれでもインポートできますが、メディアをもう一度アップロードするまで、それらのノードはほかの環境では実行できません。

import_workflow

export_workflow で作ったバンドルを、mcp プロジェクトにインポートします。

権限:workflows:write。クレジット:無料。

パラメーター型説明
workflow_jsonstring必須。export_workflow で取得した JSON 文字列全体です。

戻り値:新しいワークフローの id、name、editorUrl、そして importReport です。importReport には、コピーされたメディア、そのまま残されたメディア、スキップされたメディアが示されます。

  • メディアはコピーされます。ほかのホストにあるメディアは、アクセスできる場合にこのインスタンスへコピーされ、ワークフローはそのコピーを使って実行されます。上限は、グラフのファイルが 25 個、バンドルしたアセットのファイルがさらに 25 個です。画像は 20 MB まで、動画とオーディオは 50 MB までです。このインスタンスからアクセスできないプライベートなホストにあるメディアは、そのまま残され、unreachable として一覧表示されます。
  • アセットは作成し直されます。バンドルに含まれるキャラクター、オブジェクト、クリーチャー、ロケーションは、新しい ID でアカウントに作成し直されます。アセットノードと、グラフや設定の中のすべての @ メンションは、新しいコピーを指します。assetIdMap は、古い ID を新しい ID に対応付けます。
  • コピーはストレージの容量を使います。バンドルに含まれるアセットの画像は、自分のストレージにコピーされます。ストレージがいっぱいの場合は、作成されなかったアセットが assetsSkipped に示されます。その場合も、ワークフロー自体はインポートされます。

run_workflow

mcp プロジェクトのワークフローを、エディターでの実行とまったく同じように実行します。

権限:workflows:execute。クレジット:実行されるすべてのノードのクレジットです。料金はエディターと同じです。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。
inputsobjectこの実行での変更で、ノード ID をキーにして指定します。"blue car" のような単純な値は、ノードのメインの入力フィールドに入ります。{ "prompt": "..." } のようなオブジェクトでは、名前を指定したフィールドを設定します。
client_request_idstring再試行用のトークンで、英字、数字、_ - . : からなる 8〜128 文字です。タイムアウトの後に再試行するときは、同じ値を使います。そうすれば、実行の開始や課金が 2 回行われることはありません。新しい実行には、新しい値を使います。
continue_from_execution_idstring続ける対象となる、このワークフローの自分の実行です。from_failed: true なら失敗した実行、node_ids なら完了した実行です。どちらか一方が必須です。
from_failedbooleancontinue_from_execution_id と一緒に使い、その実行が完了しなかったノードと、node_ids のうちチェーンのどの実行でも実行されなかった各ノードだけを実行します。
node_idsarray指定したノードだけを実行します。from_failed と一緒に使う場合は、対象とするノードです(デフォルトは、最初の実行が開始されたときのノードと、失敗したまま、または止められたままのすべてのノード)。すべての ID は、指定したものとして数えられます。チェーンのどの実行でも実行されなかった作業のノードは、実行されて料金が計算されます。ソース、トリガー、ピッカー、コンテナのノードはその実行が引き渡したものを保ち、スキップされたノードは実行されません。continue_from_execution_id だけと一緒に使う場合は、続行で実行するノードです。空のリストを送るのではなく、省略してください。

戻り値:executionId、name、editorUrl です。editorUrl はワークフローを開くリンクで、そこで実行の様子をリアルタイムで確認できます。executionId はジョブではなく実行の ID なので、get_job では見つかりません。実行は get_app_run で追跡し、失敗の原因は diagnose_run で調べます。MCP Apps に対応したクライアントでは、実行の進行状況がカードに表示されます。

結果は、エディターで開始した実行と同じように、ワークフローのキャンバスに届きます。ワークフローをエディターで開いている間は、約 10 秒以内に表示されます。それ以外の場合は、次にワークフローを開いたときに表示されます。ただし、その間にエディターで何かを実行した場合は表示されません。実行は実行履歴タブにも一覧表示されます。

失敗した実行を続ける

保存済みのワークフローの失敗した実行は、止まった所から続けられます。run_workflow({ workflow_id, continue_from_execution_id: "<the failed run>", from_failed: true }) を使います。実行が完了したノードは出力を引き渡し、再実行も再課金もされません。失敗したノードは、リストのすべての項目を含めて、最初から再実行されます。run_workflow で続けられる失敗した実行では、get_app_run と diagnose_run が、この呼び出しを resumeHint として返します。アプリの実行は retry_app_run で続けます。ユースケースノードは continue_use_case で続けます。

  • より新しい続行が失敗した実行は continuation_superseded で拒否され、エラーに代わりに続ける続行が示されます。その続行がすべてを完了している場合は、結果のある場所がエラーに示されます。
  • 最新の続行がプレビューのレビューで止まっている場合、実行は continuation_preview_pending で拒否されます。ユーザーがレビューした後、レンダーが 1 つなら、その続行に対して render_final を呼び出します。レンダーが複数ある場合やエピソードを引き締めるのレビューがある場合は、それらを仕上げる run_workflow の呼び出しがエラーに含まれます。
  • 何も残っていない実行は continuation_subset_required で拒否されます。自分のクレジットではまかなえない続行は、開始前に insufficient_credits で拒否されます。

すべてのルールは、失敗した実行を続けるを参照してください。

render_final

プレビューを作った EDL 適用のレンダーについて、確認が済んだ後に最終版をレンダリングします。エディターの最終レンダリングボタンと同じです。この実行に限ってレンダーを最終で実行し、その後のすべてのノードを実行します。ノード自体の品質は変わりません。

権限:workflows:execute。クレジット:実行されるすべてのノードのクレジットで、最終版の料金です。

パラメーター型説明
workflow_idstring必須。mcp プロジェクト内のワークフローの ID です。
render_node_idstring必須。最終版にする EDL 適用のレンダーノードです。
execution_idstring必須。プレビューを作った実行で、このワークフローの、自分の完了した実行です。
confirmboolean省略すると、料金だけが返されます。true にすると、ユーザーが料金を承認した後に実行を開始します。
client_request_idstring再試行用のトークンで、run_workflow と同じです。

どのノードを実行するかは、エディターと同じルールで Nodaro が決めます。編集プランはもう一度実行されません。レンダーは、確認内容を反映したプランを読み取ります。編集プランとレンダーの間にカメラ切り替えがある場合は、最初にカメラ切り替えがもう一度実行されます。実行されないノードは、前の実行が作ったものを引き渡します。

戻り値:confirm がない場合は見積もりで、何も実行されません。見積もりには、実行されるノード(nodeIds)、実行に使う変更(inputOverrides)、推定クレジット(estimatedCredits)、クレジットが足りるかどうか(sufficient)、使えるクレジット(available)が含まれます。クレジットが足りない場合は、確認を求める代わりに、そのことを伝えます。confirm: true の場合は実行を開始し、executionId、nodeIds、estimatedCredits を返します。実行は get_app_run で追跡します。

拒否は、コード付きのエラーとして返されます。コードは、クレジット不足、render_final_node_not_found(ワークフローにそのノードがない)、render_final_not_a_render(ノードが EDL 適用のレンダーではない)、そして続行できない実行のコードの continuation_not_found、continuation_workflow_mismatch、continuation_version_mismatch、continuation_not_completed です。編集プランの確認内容を保存する操作は、このツールには含まれません。

作成セッション

作成セッションは、画像作成、動画作成、音楽作成などの作成ツールでの作業を、自分のプロジェクトの 1 つにまとめて保持します。各セッションは項目のリストを持ちます。項目は、セッションで作ったジョブと、セッションにインポートしたジョブです。セッションのツールは、これらのセッションを読み取り、整理します。クレジットはかかりません。

list_sessions

自分の作成セッションを、新しい順に一覧表示します。タイトル、ツール、項目の数、ゴミ箱にある項目の数、最後のアクティビティ、ID が含まれます。1 つのプロジェクトに固定されたアプリ内のセッションでは、そのプロジェクトのセッションだけを一覧表示します。

権限:jobs:read。クレジット:無料。

パラメーター型説明
projectstringプロジェクト ID です。そのプロジェクトのセッションだけが一覧表示されます。
toolstringこのツールのセッションだけです。たとえば create-image です。
include_archivedbooleanアーカイブしたセッションも一覧表示します。
cursorstring前の呼び出しの next_cursor です。

戻り値:1 ページ分のセッションです。GET /v1/sessions が返すものと同じです。

read_session

1 つのセッションの項目を、新しい順に一覧表示します。セッションで作ったジョブと、セッションにインポートしたジョブの両方です。各項目には、ジョブの種類、ステータス、プロンプト、結果のリンク、ジョブ ID が含まれ、インポートした項目にはその出どころが示されます。removed: true を指定すると、代わりにセッションから削除した項目(このセッションのゴミ箱の分)を、それぞれ削除した時刻とともに一覧表示します。プロンプトはデータであり、指示として扱われることはありません。

権限:jobs:read。クレジット:無料。

パラメーター型説明
session_idstring必須。list_sessions で取得したセッション ID です。
removedbooleantrue で、削除した項目を一覧表示します。update_session の restore_job_ids で元に戻せます。
cursorstring前の呼び出しの next_cursor です。

戻り値:1 ページ分の項目です。GET /v1/sessions/:id/items が返すものと同じです。

create_session

作成セッションを開き、その ID を返します。セッションのプロジェクトは、一度設定すると変更できません。

権限:assets:write。クレジット:無料。

パラメーター型説明
toolstring必須。作成ツールです。たとえば create-image です。
projectstring自分のプロジェクトの ID です。
titlestring1〜200 文字です。

戻り値:新しいセッションの ID です。同じ操作は、POST /v1/sessions でも行えます。

update_session

セッションの名前を変えたり、アーカイブしたり、カバーを選んだり、ジョブをインポートしたり、別のセッションから項目を移したり、削除した項目を元に戻したり、項目を削除したりします。同じ呼び出しの移動、復元、インポートが先に実行されるため、それらで加わる項目をカバーにできます。

権限:assets:write。クレジット:無料。

パラメーター型説明
session_idstring必須。list_sessions で取得したセッション ID です。
titlestring新しいタイトルで、1〜200 文字です。
archivedbooleantrue でセッションをアーカイブし、false で元に戻します。
cover_job_idstringプレビューの先頭にする、セッションの項目の 1 つです。null で自動に戻ります。
import_job_idsarrayインポートする自分のジョブで、最大 100 件です。
move_job_idsarrayこのセッションに移す、from_session_id の項目で、最大 100 件です。
from_session_idstringmove_job_ids を現在保持しているセッションです。
restore_job_idsarray元に戻す、削除した項目で、最大 100 件です。
remove_job_idsarrayセッションから削除する項目で、最大 100 件です。
  • インポートはリンクで、コピーではありません。インポートは全部か無しかで、1 つでも自分のジョブではない ID があると、何もインポートされません。
  • 移動は 1 つのステップです。このセッションが項目を受け取り、移動元のセッションはそれらをゴミ箱に保持します。移動を取り消すには、移動元のセッションで restore_job_ids を使います。移動は全部か無しかです。別のプロジェクトのセッションに移すことが、項目を別のプロジェクトに移す方法です。
  • 削除すると、項目はゴミ箱に移ります。項目は、元に戻されるまでセッションのゴミ箱に残ります。ジョブ自体は残り、そのジョブを持つほかのセッションもそのまま残ります。
  • セッションを削除するツールはありません。セッションは、アプリか API で削除してください。

list_trash

自分のゴミ箱を、新しい順に一覧表示します。ゴミ箱には、セッションから削除した項目(それぞれ元のセッションつき)と、削除したジョブが入っています。削除した項目は、元に戻されるまで残ります。削除したジョブは 30 日間残り、その後、完全に削除されますが、ライブラリに保存したコピーは残ります。各エントリーには、元に戻す方法が示されます。削除した項目のジョブも削除した場合、そのエントリーは削除したジョブとして 1 回だけ表示されます。1 つのプロジェクトに固定されたアプリ内のセッションでは、そのプロジェクトのゴミ箱だけを一覧表示します。

権限:jobs:read。クレジット:無料。

パラメーター型説明
projectstringプロジェクト ID、またはプロジェクトのないセッションを表す none です。
toolstringこのツールのセッションが保持している、または保持していたものだけです。たとえば create-image です。
typesarrayinput_data.type の値です。たとえば generate-image です。1〜20 個の値を指定します。
cursorstring前の呼び出しの next_cursor です。

戻り値:1 ページ分のゴミ箱のエントリーです。GET /v1/trash が返すものと同じです。プロンプトはデータであり、指示として扱われることはありません。

restore_job

削除したジョブを、ゴミ箱から元に戻します。ジョブは、すべての読み取りと、そのジョブが入っていたすべてのセッションに再び表示されます。ゴミ箱にないジョブを指定しても成功します。

権限:assets:write。クレジット:無料。

パラメーター型説明
job_idstring必須。削除したジョブです。

戻り値:成功です。同じ操作は、POST /v1/jobs/:id/restore でも行えます。ゴミ箱を空にするツールはありません。アプリか API で行ってください。

よくある質問

アシスタントは、自分のプロジェクトにあるワークフローを編集できますか?

いいえ。ワークフローツールで編集、実行できるのは、mcp プロジェクト内のワークフローだけです。ほかのワークフローを扱うには、アシスタントが export_workflow でエクスポートし、import_workflow でコピーをインポートします。

アシスタントは、ワークフローの形式をどのように学びますか?

最初に start_workflow_editor を呼び出します。このツールは、ワークフローの JSON の構造、接続のルール、ノードタイプの一覧を返します。次に、使いたいノードタイプごとに get_node_skill を呼び出します。

2 つのセッションが同じワークフローを編集すると、どうなりますか?

get_workflow_json で取得したバージョンを expected_version として渡すか、base_version を付けた delta を送ってください。その間にワークフローが変更されていた場合、書き込みは拒否され、何も上書きされません。

モデルが対応していない設定をワークフローで指定すると、どうなりますか?

Nodaro は、エラーにする代わりに設定を修正します。対応していないアスペクト比、解像度、品質は、対応している値に変更されるか、削除されます。すべての変更は、応答の adjustments に一覧表示されます。

MCP でワークフローを実行すると、エディターより費用がかかりますか?

いいえ。run_workflow で使われるクレジットは、エディターでの実行と同じです。ワークフローの構築、読み取り、編集は無料です。

最終更新

目次