ワークフローとプロジェクト
client.workflows を使って、TypeScript から Nodaro のワークフローを作成、更新、共有、エクスポート、インポート、実行し、client.projects でプロジェクトに整理します。
client.workflows は Nodaro のワークフローの読み取り、書き込み、共有、実行を行い、client.projects はワークフローを入れるプロジェクトを管理します。client.sessions は、単体の生成をプロジェクト内のセッションにまとめます。ワークフローは接続されたノードからなるキャンバスで、どのワークフローも 1 つのプロジェクトに属します。これらのメソッドは、ワークフローの REST API と同じエンドポイントを呼び出します。概念については、ワークフローとプロジェクトを参照してください。
メソッド
| メソッド | 内容 |
|---|---|
workflows.list(params) | プロジェクトのワークフローを、グラフを除いて一覧表示します |
workflows.get(id) | 1 つのワークフローを、ノード、接続、設定とともに読み取ります |
workflows.getPublic(id) | リンクで共有されたワークフローを、トークンなしで読み取ります |
workflows.create(input) | プロジェクトにワークフローを作成します |
workflows.update(id, input) | ワークフローの任意のフィールドを変更します |
workflows.delete(id) | ワークフローを削除します |
workflows.run(id, params?) | ワークフローの実行を開始します |
workflows.renderFinal(id, params) | プレビューを確認したあと、EDL 適用のレンダリングの最終版をレンダリングします |
workflows.estimateRenderFinal(id, params) | その最終レンダリングを開始する前に見積もります |
workflows.export(workflowId, opts?) | ワークフローを、移植可能な JSON バンドルとしてエクスポートします |
workflows.import(input) | バンドルをプロジェクトにインポートします |
workflows.setVisibility(id, visibility) | ワークフローを非公開にするか、ワークスペースに公開します |
workflows.move(id, params) | ワークフローを別のプロジェクトに移動します |
workflows.sharedWithMe() | ほかの人から共有されたワークフローを一覧表示します |
workflows.listMcpConversations(params?) | 1 か月分の MCP 会話を一覧表示します |
workflows.collaborators.* | ワークフローの共有相手を一覧表示、追加、変更、削除します |
projects.list() ほか | プロジェクトを一覧表示、読み取り、作成、更新、削除します |
sessions.create(input) ほか | プロジェクト内の生成セッションと、セッションが持つジョブ |
client.workflows
list(params)
プロジェクト内のワークフローを一覧表示します。一覧で返されるのはメタデータだけで、nodes、edges、settings、sourcePrompt は含まれません。グラフ全体を取得するには、get() で 1 つのワークフローを読み取ります。
list(params: { projectId: string }): Promise<{ data: Workflow[] }>プロパティ
型
const { data: workflows } = await client.workflows.list({ projectId })
for (const wf of workflows) console.log(wf.id, wf.name, wf.updatedAt)あなたから見えないプロジェクトを指定すると、NotFoundError をスローします。
get(id)
1 つのワークフローを、完全な nodes、edges、settings を含めて読み取ります。
get(id: string): Promise<{ data: Workflow }>プロパティ
型
const { data: wf } = await client.workflows.get(workflowId)
console.log(`${wf.name}: ${wf.nodes?.length ?? 0} nodes, version ${wf.version}`)ワークフローを更新する予定がある場合は、version を保持しておいてください。version を使うと、ほかの人の書き込みがあっても、安全に更新できます。
getPublic(id)
所有者がリンクで共有したワークフローを読み取ります(GET /v1/public/workflows/:id)。トークンは不要です。ワークフローが返されるのは、共有がオンになっている間だけです。オフの場合、このメソッドは NotFoundError をスローします。所有者以外が読み取る UGC 動画は、公開アプリが配布するときと同じ形で返されます。UGC のノードと、そこから作られたすべてのノードは結果を含まず、所有者の写真は決して含まれません。公開作品を許可していないデプロイメント(outputs.allowPublic: false)では、共有されていないワークフローと同じく、ログインしているワークフローの所有者以外の全員に対して、このメソッドは NotFoundError をスローします。
getPublic(id: string): Promise<{ data: Workflow }>プロパティ
型
const { data: shared } = await client.workflows.getPublic(workflowId)認証プロバイダーがトークンを返さない場合、リクエストはトークンなしで送られます。
共有されたスタジオ制作は、所有者の作業中の状態を含まずに返されます。ごみ箱、進行中の実行、空のメディアスロット、保存していないエディターの下書きは、settings.studio から除かれます。
create(input)
プロジェクトにワークフローを作成し、完全なレコードを返します。必要なのは projectId と name だけで、ほかのフィールドにはサーバーのデフォルト値が使われます。
create(input: CreateWorkflowInput): Promise<{ data: Workflow }>プロパティ
型
const { data: wf } = await client.workflows.create({
projectId,
name: "Product launch video",
nodes: [],
edges: [],
})できあがったグラフを使うには、エディターで作ったワークフローをエクスポートして、その nodes と edges を読み取るか、テンプレートを複製します。
update(id, input)
ワークフローのフィールドを任意の組み合わせで変更し、更新後の完全なレコードを返します(PATCH /v1/workflows/:id)。指定しなかったフィールドは、そのまま残ります。
update(id: string, input: UpdateWorkflowInput): Promise<{ data: Workflow }>プロパティ
型
await client.workflows.update(workflowId, { name: "Renamed", expectedVersion: 7 })安全な更新:expectedVersion も expectedUpdatedAt も指定しない場合は、最後の書き込みが優先されます。どちらかを指定すると、読み取った後に誰もワークフローを変更していない場合にだけ、更新が適用されます。変更されていた場合は WorkflowConflictError をスローします。その currentRecord には現在のワークフローが入っているので、もう一度読み取らずにマージできます。
import { WorkflowConflictError } from "@nodaro/sdk"
try {
await client.workflows.update(workflowId, { settings, expectedVersion: wf.version })
} catch (err) {
if (err instanceof WorkflowConflictError && err.currentRecord) {
const merged = mergeSettings(err.currentRecord.settings, settings)
await client.workflows.update(workflowId, {
settings: merged,
expectedVersion: err.currentVersion,
})
} else {
throw err
}
}ノードデータにある実行状態の値(実行中のステータスや、現在のジョブ ID など)は、サーバーによって削除され、保存されることはありません。
delete(id)
ワークフローを削除します。
delete(id: string): Promise<{ success: true }>プロパティ
型
await client.workflows.delete(workflowId)ID が存在しない場合や、あなたのものではない場合は、NotFoundError をスローします。そのため、削除が何も知らせずに失敗することはありません。
run(id, params?)
ワークフローの実行を開始し、すぐに { executionId, status } を返します。実行は、サーバー上で続きます。進行状況と結果は、client.executions.get() をポーリングして取得します。
run(id: string, params?: {
nodeIds?: string[]
inputOverrides?: Record<string, Record<string, unknown>>
continueFromExecutionId?: string
continueMode?: "from-failed"
}, options?: { idempotencyKey?: string }): Promise<{ executionId: string; status: "pending" | "running" }>プロパティ
型
const { executionId } = await client.workflows.run(workflowId, {
nodeIds: ["text-prompt-1", "image-gen-2"],
})
const { data: execution } = await client.executions.get(executionId)- アカウントの残高が、実行にかかりうる最大の料金に足りない場合は、
InsufficientCreditsErrorをスローします。 - このワークフローの実行がまだ進行中の間に新しく実行すると、
AlreadyRunningError(409 already_running)がスローされます。そのexecutionIdが、追うべき実行です。 - OAuth トークンには、
workflows:executeスコープが必要です。 - ワークスペース内のワークフローを実行するには、
client.withWorkspace()で得たクライアントでrunを呼び出します。
以前の実行を続ける。 continueFromExecutionId を指定すると、nodeIds のノードだけが実行されます。ほかのノードはすべて、以前の実行が作ったものを渡します。ワークフローの保存済みの結果を代わりに渡すことはありません。編集プランは、現在のレビューを反映したプランを渡します。以前の実行の inputOverrides が再び適用され、今回送る値がフィールドごとにその上に適用されます。
await client.workflows.run(workflowId, {
nodeIds: [renderNodeId, captionsNodeId],
inputOverrides: { [renderNodeId]: { quality: "final" } },
continueFromExecutionId: previewRunId,
})拒否された継続は、実行が作られる前にエラーを投げます。以前の実行が見つからない場合は、コード continuation_not_found の NotFoundError です。それ以外は、code が continuation_subset_required(nodeIds なし)、continuation_workflow_mismatch、continuation_version_mismatch、continuation_not_completed のいずれかの NodaroError です。
失敗した実行を続ける。 continueMode: "from-failed" を指定すると、continueFromExecutionId はこのワークフローの自分の失敗した実行になり、実行は止まった所から続きます。実行されるのは、その実行が完了しなかったノードだけです。完了したものは引き渡され、再実行も再請求もされません。失敗したノードは、最初から再実行されます。nodeIds は任意です。省略すると、実行が開始されたときのノードに、失敗したまま、または止められたままのすべてのノードを加えて続行されます。client.executions.get(id) は、最初の実行が開始されたときのノードを nodeScope に示します(null はすべてのノードです)。nodeIds のすべての ID は、指定したものとして数えられます。チェーンのどの実行でも実行されなかった作業のノードは、実行されて料金が計算されます。チェーンのいずれかの実行で実行されたノードは、指定しても再実行されません。ソースやアップロード、トリガー、ピッカー、グループや収集のコンテナは、その実行が引き渡したものを引き渡し、スキップに設定されたノードは実行されません。同じ呼び出しを再試行しても何も新しく開始されないように、idempotencyKey を送信してください。
await client.workflows.run(
workflowId,
{ continueFromExecutionId: failedRunId, continueMode: "from-failed" },
{ idempotencyKey: crypto.randomUUID() }, // reuse the same key when you retry this call
)- より新しい継続に置き換えられた実行は、コード
continuation_supersededのNodaroErrorをスローします。メッセージにその継続が示されます。代わりにそちらを続けてください。その継続が残りをすべて完了している場合は、そこで結果を確認できます。 - 最新の継続がプレビューのレビューで止まっている場合、呼び出しは
ContinuationPreviewPendingError(コードcontinuation_preview_pending、@nodaro/sdk/errorsからエクスポート)をスローします。そのnextは、レビューを仕上げる実行です。先にclient.workflows.run(workflowId, error.next)を送信してから、続けてください。 - 失敗していない実行は、
continuation_not_failedをスローします。何も残っていない実行は、continuation_subset_requiredをスローします。 - 自分のクレジットではまかなえない継続は、実行が作られる前に
InsufficientCreditsErrorをスローします。
すべてのルールは、失敗した実行を続けるを参照してください。
プレビューで実行が止まってレビューを待つインストールでは、EDL 適用のレンダリングがプレビューに設定されたワークフローの実行は 400 preview_review_required で拒否されます。SDK の実行は誰もレビューしないためです。inputOverrides: { [renderNodeId]: { quality: "final" } } で、その実行だけレンダリングを最終に設定してください。Nodaro Cloud では実行がプレビューで止まらないので、この拒否は起こりません。
renderFinal(id, params)
プレビューを作った EDL 適用のレンダリングについて、確認したあとに最終版をレンダリングします。エディターの最終レンダリングボタンと同じものを実行します。この実行に限ってレンダリングを最終品質で行い、その後のすべてのノードを実行します。ノード自身の品質は変わりません。編集プランとレンダリングの間にカメラ切り替えがある場合は、先にカメラ切り替えを再実行します。
renderFinal(id: string, params: { renderNodeId: string; continueFromExecutionId: string }): Promise<{ executionId: string; status: "pending" | "running" }>プロパティ
型
実行するノードはサーバーがエディターと同じルールで決めるので、送るのはレンダリングと以前の実行だけです。実行しないノードはすべて、以前の実行が作ったものを渡します。
const { executionId } = await client.workflows.renderFinal(workflowId, {
renderNodeId,
continueFromExecutionId: previewRunId,
})- 存在しないノード ID は
render_final_node_not_foundで、EDL 適用のレンダリングではないノードはrender_final_not_a_renderで拒否されます。run()の継続のコードも適用されます。 - 支払う側がまかなえない実行は、実行が作られる前に
InsufficientCreditsError(402)を投げ、requiredとavailableを含みます。 - OAuth トークンには
workflows:executeスコープが必要です。
estimateRenderFinal(id, params)
renderFinal() を見積もり、何も作りません。パラメーターは同じです。
estimateRenderFinal(id: string, params: { renderNodeId: string; continueFromExecutionId: string }): Promise<{ data: RenderFinalQuote }>const { data: quote } = await client.workflows.estimateRenderFinal(workflowId, {
renderNodeId,
continueFromExecutionId: previewRunId,
})
if (quote.sufficient) {
await client.workflows.renderFinal(workflowId, { renderNodeId, continueFromExecutionId: previewRunId })
}RenderFinalQuote は、renderNodeId、nodeIds(実行されるノード)、inputOverrides(実行に使う上書き)、estimatedCredits、holdCredits、sufficient、available を持ちます。holdCredits は、レンダリング中に実行が確保するクレジットです。UGC クリップはその確保額(料金の約 2 倍)で数えられ、見積もりを下回ることはありません。sufficient は支払う側がその確保額をまかなえるかどうかを、available は支払う側が使えるクレジットを示します。ワークスペースの予算から支払う場合、available は null です。クレジットのないエディションでは、金額の値は null です。実行で LLM ノードが動く場合、見積もりには estimatedCreditsIsEstimate: true が加わります。そのノードには実際の使用分が請求されるので、数値は ≈N と表示してください。
export(workflowId, opts?)
ワークフローの保存済みのバージョンを、移植可能な JSON バンドルとしてエクスポートします。これは、エディターのエクスポートメニューが書き出すのと同じファイル形式です。assets: true を指定すると、エディターのアセットを含めると同じように、ワークフローが使うアセットもバンドルに含まれます。
export(workflowId: string, opts?: { assets?: boolean }): Promise<{ data: WorkflowExport }>プロパティ
型
const { data: bundle } = await client.workflows.export(workflowId, { assets: true })移植性:バンドルが参照できるのは、ほかのインスタンスが取得できるメディアだけです。ほかのインスタンスからアクセスできない URL をノードが使っている場合、バンドルはそれらを portability.unreachableMedia に列挙します。たとえば、localhost 上にあるセルフホスティング環境自身のストレージ、ローカルネットワークのアドレス、.internal の名前などです。
bundle.portability?.unreachableMedia
// [{ nodeId: "n1", nodeLabel: "Video URL", field: "videoUrl", url: "http://localhost:3000/storage/..." }]すべてのメディアの URL が公開されている場合、このフィールドはありません。アクセスできないメディアを含むバンドルもインポートはできますが、該当するノードは、メディアをアップロードし直すまで、インポート先のインスタンスでは実行できません。インポートとエクスポートを参照してください。
import(input)
エクスポートしたバンドルを、自分のプロジェクトのいずれかにインポートし、新しいワークフローを返します。
import(input: WorkflowExport & { projectId: string }): Promise<{
data: Workflow
importReport?: WorkflowImportReport
}>プロパティ
型
const { data: wf, importReport } = await client.workflows.import({ ...bundle, projectId })インポートでは、次の処理が行われます。
- アセットが作成し直されます:バンドル内のキャラクター、オブジェクト、クリーチャー、ロケーションは、あなたのアカウントの新しい項目になります。ワークフローの参照先も、それらに付け替えられます。対象は、アセットノード、ノードデータ内のすべての
@メンション、ワークフローの設定です。 - メディアがコピーされます:ほかのホストにあるメディアは、アクセスできる場合、このインスタンスのストレージにコピーされます。そのため、ワークフローがほかの人のサーバーに依存することはありません。上限は、ワークフローのメディアで 25 ファイル、同梱のアセットでさらに 25 ファイルです。画像は 20 MB まで、動画とオーディオは 50 MB までです。
- コピーはストレージの使用量に含まれます:ストレージが足りなくなっても、ワークフロー自体はインポートされ、収まらなかったアセットはレポートに一覧表示されます。
importReport は、何が起きたかを示します。
importReport
// {
// rehosted: 3, // files copied to this instance
// unreachable: [{ nodeId, nodeLabel, field, url }], // private hosts, left as they were
// skipped: [{ nodeId, field, url, reason: "HTTP 404" }],
// assetIdMap: { "<bundled asset id>": "<new asset id>" },
// assetsSkipped: [{ kind: "character", id, name: "Kira", reason: "Storage limit exceeded" }],
// }assetIdMap は、バンドルがアセットを含んでいた場合に必ず存在します。ワークフロー内のメンションは、サーバーがすでにすべて更新しています。このマップは、ワークフローの外で保持している参照にだけ使ってください。assetsSkipped が含まれるのは、何かが除外された場合だけです。
setVisibility(id, visibility)
ワークフローを、作成者と追加した共同編集者だけが見られる "private" にするか、ワークスペースの全員が見られる "workspace" にします。
setVisibility(id: string, visibility: "private" | "workspace"): Promise<{ data: Workflow }>プロパティ
型
await client.workflows.setVisibility(workflowId, "workspace")変更できるのは、作成者かワークスペースの管理者だけです。それ以外の人が変更しようとすると、ForbiddenError がスローされます。ワークスペースは、Nodaro Cloud の組織にあります。
move(id, params)
ワークフローを別のプロジェクトに移動します(POST /v1/workflows/:id/move)。ワークフローは、元のフォルダーから外れます。
move(id: string, params: { projectId: string }): Promise<{
data: Workflow
droppedCollaborators: { userId: string; name: string | null }[]
}>プロパティ
型
const { droppedCollaborators } = await client.workflows.move(workflowId, { projectId: archiveProjectId })移動によってワークフローがワークスペースの外に出る場合、そのワークスペースから得ていたアクセス権はなくなります。アクセス権を失った人は、droppedCollaborators で返されます。
sharedWithMe()
ほかの人があなたに直接共有したワークフローを一覧表示します。所属しているワークスペース内の作品は、そのワークスペース自身の一覧にすでに表示されるため、含まれません。各ワークフローには、あなたがそのワークフローに対して持つ grantedRole が付いています。
sharedWithMe(): Promise<{ data: (Workflow & { grantedRole: "viewer" | "editor" })[] }>const { data: shared } = await client.workflows.sharedWithMe()
for (const wf of shared) console.log(wf.name, wf.grantedRole)組織のないインスタンスでは、この一覧は空です。
listMcpConversations(params?)
GET /v1/mcp-conversations を通じて、1 か月分の MCP 会話を新しい順に一覧表示します。各会話は、アシスタントがそのステップから組み立てたワークフローです。MCP 会話がワークフローになる仕組みを参照してください。
listMcpConversations(params?: { month?: string; sources?: string[] }): Promise<McpConversationList>monthは"YYYY-MM"です。デフォルトは、会話がある最新の月です。sourcesは、一部のソースだけを残します。たとえば"claude"、"claude-code"、"chatgpt"です。
結果には、month、months(会話があるすべての月と、それぞれの件数)、sources(その月のソースと、それぞれがまとめる接続)、data(McpConversation[])が含まれます。会話はワークフローなので、get(conversation.id) で開けます。
const { data, months } = await client.workflows.listMcpConversations({ month: "2026-10", sources: ["claude-code"] })collaborators
ワークフローの共有相手です。client.workflows.collaborators からアクセスします。これらのメソッドは、組織のあるインスタンスで使えます。それ以外のインスタンスでは、NotFoundError をスローします。
collaborators.list(workflowId: string): Promise<{ data: Collaborator[] }>
collaborators.add(workflowId: string, input: { userId?: string; email?: string; role: "viewer" | "editor" }): Promise<{ data: { userId: string; role: "viewer" | "editor" } }>
collaborators.update(workflowId: string, userId: string, input: { role: "viewer" | "editor" }): Promise<{ data: { userId: string; role: "viewer" | "editor" } }>
collaborators.remove(workflowId: string, userId: string): Promise<{ success: true }>プロパティ
型
await client.workflows.collaborators.add(workflowId, { email: "editor@example.com", role: "editor" })
const { data: people } = await client.workflows.collaborators.list(workflowId)
// [{ userId, name, avatar, role }]: email addresses are never returned共同編集者は、自分のユーザー ID を指定して remove() を呼び出すと、ワークフローから抜けられます。
client.projects
プロジェクトは、ワークフローをまとめるものです。どのワークフローも、ちょうど 1 つのプロジェクトに属します。
projects.list()
自分のプロジェクトを一覧表示します。
list(): Promise<{ data: Project[] }>const { data: projects } = await client.projects.list()projects.get(id)
1 つのプロジェクトを読み取ります。
get(id: string): Promise<{ data: Project }>プロパティ
型
const { data: project } = await client.projects.get(projectId)projects.create(input)
プロジェクトを作成します。
create(input: { name: string; description?: string; settings?: Record<string, unknown> }): Promise<{ data: Project }>プロパティ
型
const { data: project } = await client.projects.create({ name: "Spring campaign" })projects.update(id, input)
プロジェクトを変更します。少なくとも 1 つのフィールドを渡してください。
update(id: string, input: { name?: string; description?: string; settings?: Record<string, unknown> }): Promise<{ data: Project }>プロパティ
型
await client.projects.update(projectId, { description: "Assets for the spring launch" })projects.delete(id)
プロジェクトを削除します。
delete(id: string): Promise<{ success: true }>プロパティ
型
await client.projects.delete(projectId)client.sessions
生成セッションは、プロジェクト内の単体の生成をまとめたもので、どのデバイスでも同じ内容です。プロジェクトがセッションを持ち、各セッションがアイテムを持ちます。セッションのプロジェクトは、作成時に決まります。各アイテムは自分のジョブの 1 つへのリンクで、コピーではありません。
const { data: session } = await client.sessions.create({ projectId, tool: "create-image", title: "Beach" })
// A job joins a session when the generation request names it.
await client.nodes.runAndWait("generate-image", {
prompt: "a red car",
sessionId: session.id,
origin: "create-image",
})
const { data: sessions, next } = await client.sessions.list({ projectId })
const { data: items } = await client.sessions.items(session.id)| メソッド | シグネチャ | 補足 |
|---|---|---|
create | create(input: CreateSessionInput): Promise<{ data: GenerationSession }> | tool は必須で、たとえば create-image です。projectId と title は省略できます。 |
list | list(params?: ListSessionsParams): Promise<SessionPage<GenerationSession>> | 新しい順です。フィルターは projectId(プロジェクトのないセッションは "none")、tool、includeArchived、limit、cursor です。各セッションには、itemCount(有効なアイテムの数)、removedCount(ゴミ箱にあるアイテムの数)、coverJobId、最大 4 つの previewUrls(カバーが設定されていれば、その画像が先頭)が含まれます。 |
get | get(id: string): Promise<{ data: GenerationSession }> | 1 つのセッションです。 |
update | update(id: string, input: UpdateSessionInput): Promise<{ data: GenerationSession }> | title(null にすると無題になります)、archived、coverJobId(セッションのアイテムの 1 つ。それ以外は 404。null は自動)です。プロジェクトは変更できません。 |
delete | delete(id: string): Promise<{ success: true }> | セッションを削除します。そのジョブは残り、ジョブを持つほかのすべてのセッションにもそのまま残ります。 |
items | items(id: string, params?: ListSessionItemsParams): Promise<SessionPage<SessionItem>> | 有効なアイテムの、新しい順のフィードです。各アイテムは、jobId、addedAt、removedAt、imported、importedFrom、job を持ちます。{ removed: true } を付けると、代わりにセッションから外したアイテム(このセッションのゴミ箱)を、外した時刻の新しい順に一覧にします。 |
importItems | importItems(id: string, input: { jobIds: string[] }): Promise<{ data: { imported: number; requested: number } }> | 自分の有効なジョブを最大 100 件、セッションにリンクします。すべて成功するか、すべて失敗するかのどちらかです。自分のものでないジョブが 1 件でもあると、呼び出しは 404 で失敗します。セッションから外したアイテムは、元の位置に戻ります。 |
moveItems | moveItems(targetId: string, input: MoveSessionItemsInput): Promise<{ data: { moved: number } }> | { jobIds, fromSessionId } を、1 回のトランザクションで移します。移動先がアイテムを受け取り、移動元はそれらを外したアイテムとして保持するので、restoreItem(fromSessionId, jobId) で移動を取り消せます。すべて成功するか、すべて失敗するかのどちらかです。いずれかの ID が移動元の有効なアイテムでない場合は 404 になります。 |
removeItem | removeItem(id: string, jobId: string, options?: { forever?: boolean }): Promise<{ success: true }> | アイテムをセッションのゴミ箱に移し、復元されるまでそこに残します。自動では何も削除されません。ジョブと、それを持つほかのすべてのセッションは残ります。{ forever: true } を付けると、すでに外したアイテムを完全に削除します。有効なアイテムでは、409 の NodaroError not_in_trash を投げます。 |
restoreItem | restoreItem(id: string, jobId: string): Promise<{ success: true }> | 外したアイテムを、セッションの元の位置に戻します。 |
セッションのプロジェクトは固定されているので、アイテムのプロジェクトを変えるには、別のプロジェクトのセッションにアイテムを移します。そのセッションで moveItems() を呼び出してください。どのセッションにも保持されなくなったアイテムは、一般に表示されます:client.jobs.list({ inSession: false })。
client.trash
ゴミ箱には、セッションから外したアイテムと、削除したジョブが入っています。作成ツールでは、一般の横の 1 つの項目として表示されます。ゴミ箱を参照してください。
list(params?: ListTrashParams): Promise<TrashPage> // GET /v1/trash
interface ListTrashParams {
projectId?: string | "none" // a project, or the sessions with no project and General
tool?: string // what a session of this tool holds or held
type?: string | string[] // input_data.type, like jobs.list
limit?: number // 1–100 (default 50)
cursor?: string // the previous page's next
}
type TrashEntry =
| { kind: "removed"; removedAt: string; session: TrashSession; job: Job }
| { kind: "deleted"; deletedAt: string; purgeAt: string; job: Job }一覧は新しい順です。外したアイテムは、sessions.restoreItem(session.id, job.id) または sessions.removeItem(session.id, job.id, { forever: true }) を呼び出すまで残ります。削除したジョブは、deletedAt の 30 日後の purgeAt まで残り、その後、完全に削除されます。ライブラリに保存したコピーは残ります。jobs.restore(job.id) は、そのジョブが入っていたすべてのセッションにジョブを戻し、jobs.delete(job.id, { forever: true }) は今すぐ削除します。外したアイテムのジョブも削除した場合、そのエントリーは削除したジョブとして 1 回だけ表示されます。どのセッションにも入ったことがないジョブにはツールがないので、tool では除外されます。含めるには、自分のツールのジョブの種類を type に渡してください。
const { data: trash } = await client.trash.list({ projectId, type: ["generate-image", "image-edit"] })
for (const entry of trash) {
if (entry.kind === "deleted") await client.jobs.restore(entry.job.id)
else await client.sessions.restoreItem(entry.session.id, entry.job.id)
}ジョブを作成するすべてのリクエストは sessionId と origin を受け付け、プラットフォームはそれらをジョブに記録します。これらは、GenerateImageParams、GenerateVideoParams、TextToSpeechParams などのすべての生成パラメーターの型と、キャラクター、オブジェクト、ロケーション、クリーチャーの generate* の入力に型付けされています。origin はスラッグでなければなりません。小文字の英字、数字、ダッシュで、最大 40 文字です。それ以外の値は 400 validation_error で失敗します。ジョブの session_id は、client.jobs.get() と client.jobs.list() に表示されます。
型
| 型 | 構造 |
|---|---|
Workflow | id、projectId、userId、name、description?、folderId?、version?、thumbnailUrl?、nodes?、edges?、settings?、sourcePrompt?、createdAt、updatedAt。グラフのフィールドがあるのは、完全なレコードだけです。 |
RunWorkflowParams | nodeIds?、inputOverrides?、continueFromExecutionId? |
RenderFinalParams | renderNodeId、continueFromExecutionId |
RenderFinalQuote | renderNodeId、nodeIds、inputOverrides、estimatedCredits、estimatedCreditsIsEstimate?、holdCredits、sufficient、available |
Project | id、userId、name、description?、settings?、createdAt、updatedAt |
GenerationSession、SessionItem、SessionPage | 生成セッション、そのアイテムの 1 つ、そのどちらかのページ |
Collaborator | userId、name?、avatar?、role |
WorkflowExport | export() が返し、import() が受け付ける、移植可能なバンドル |
GenericNode, GenericEdge | nodes と edges で使われる、ノードと接続の構造 |
これらの型は、すべて @nodaro/sdk からエクスポートされています。型を参照してください。
よくある質問
Nodaro のワークフローを、コードから実行するにはどうすればよいですか?
client.workflows.run(workflowId) を呼び出します。すぐに executionId が返されます。ステータスが completed、failed、cancelled、timed_out のいずれかになるまで、client.executions.get(executionId) をポーリングしてください。
ワークフローの一部のノードだけを実行できますか?
はい。client.workflows.run の第 2 引数に、実行するノード ID のリストである nodeIds を持つオブジェクトを渡します。実行されるのは、指定したノードだけです。
プレビューの最終版を、コードからレンダリングするにはどうすればよいですか?
client.workflows.renderFinal を、EDL 適用のレンダリングノードの ID と、プレビューを作った実行の ID を指定して呼び出します。レンダリングを最終品質で実行し、その後のすべてのノードを実行します。client.workflows.estimateRenderFinal を使うと、先に見積もりを取得できます。
ほかの人の変更を上書きしないようにするには、どうすればよいですか?
client.workflows.update に、読み取ったバージョンを expectedVersion として渡します。その間にワークフローが変更されていた場合、呼び出しは現在のレコードを含む WorkflowConflictError をスローするので、マージしてから再試行できます。
ワークフローを別の Nodaro インスタンスにコピーするには、どうすればよいですか?
assets オプションを true にして client.workflows.export でエクスポートし、別のインスタンスで client.workflows.import と projectId を使ってバンドルをインポートします。アクセスできるメディアは、新しいインスタンスのストレージにコピーされます。
関連ページ
ジョブと実行
ノードの実行
ワークフロー
ワークフローとプロジェクト
インポートとエクスポート
最終更新