Skip to main content

概要

Jinba Flow ツールを使うことで、Jinba 上で公開されたフローを別のフロー内から実行できます。また、Jinba ツールを使って Jinba ストレージのファイル管理や Jinba テーブルのレコードの読み書きも行えます。

主な機能

  • JINBA_FLOW_RUN
    • フロー ID と必要な引数を指定して、Jinba フローを実行
  • JINBA_FILE_UPLOAD / JINBA_FILE_GET / JINBA_FILE_SEARCH / JINBA_FILE_DELETE
    • Jinba ストレージ上のファイルのアップロード、取得、検索、削除
  • JINBA_TABLE_ADD_RECORD / JINBA_TABLE_GET_RECORDS / JINBA_TABLE_UPDATE_RECORD
    • Jinba テーブルのレコードの追加、取得、更新

認証

JINBA_FLOW_RUN に config の設定は不要です。同じワークスペース内の公開済みフローを実行するツールで、認証にはワークスペース API キー(secrets.JINBAFLOW_WS_API_KEY)がサーバー側で自動的に使用され、API のベース URL もサーバー環境から解決されます。実行対象のフローは事前に公開しておいてください。 注意:API キーは機密情報として扱い、公開リポジトリにコミットしないでください。

例:他の Jinba フローを実行する

ファイルツール

ファイルツールは config の token に Jinba Flow ワークスペース API トークンを指定して認証します。デフォルトで {{ secrets.JINBAFLOW_WS_API_KEY }} が使用されるため、通常は明示的に設定する必要はありません。

JINBA_FILE_UPLOAD

Jinba ストレージにファイルをアップロードします。 入力: 出力: idnamesizeextensionmimeTypecreatedAtupdatedAtworkspaceIduserIdsignedUrl を含むファイルメタデータ。

JINBA_FILE_GET

ファイル ID を指定して、ファイルのメタデータと署名付き URL を取得します。 入力:
  • fileId(string、必須): 取得するファイルの ID
出力: JINBA_FILE_UPLOAD と同じファイルメタデータ(signedUrl を含む)。 Jinba ストレージ内のファイルを検索します。 入力: 出力: items(ファイルメタデータの配列)とページネーション用の nextCursor

JINBA_FILE_DELETE

Jinba ストレージからファイルを削除します。 入力:
  • fileId(string、必須): 削除するファイルの ID
出力: idsuccess

例:ファイルのアップロードと取得

テーブルツール

テーブルツールはワークスペースに紐づいたツールです。ワークスペースの API キーが自動的に注入されるため、config の設定は不要です。

JINBA_TABLE_ADD_RECORD

Jinba テーブルにレコードを追加します。 入力: 出力: result.recordId — 新規追加されたレコードの ID。

JINBA_TABLE_GET_RECORDS

Jinba テーブルからレコードを取得します。 入力: 出力: resultitems{ __id, __created_at, __updated_at, __version, <列名>: <値>, ... } 形式のレコード)、totallimitoffset を含みます。NUMBER 型の列は精度を保持するために文字列としてシリアライズされます。数値演算が必要な場合は後続ステップで Number(value) などで変換してください。

JINBA_TABLE_UPDATE_RECORD

Jinba テーブルのレコードを更新します。 入力: 出力: result.recordId

例:テーブルレコードの追加と更新