FLfloqer
Sheets

Create Sheet

Adds a new sheet to the workflow identified by workflow_id. Returns the full sheet object. Pass the returned sheet_id as the {sheet_id} path parameter on every sheet-scoped endpoint (Add Inputs, Add Action, Add Data, Run Sheet, etc.).

Routing data into the new sheet. Sheets receive rows via the send_to_sheet action on another sheet in the same workflow. On the source sheet, add send_to_sheet, set target_sheet_id to the sheet_id returned here, and map source fields to the new sheet's input columns. To expand a structured_array (one row per array item), set expand_from on the send_to_sheet action. Full configuration: /docs/action-detail/send_to_sheet.txt.

post/api/v1/workflows/{workflow_id}/sheets

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Workflow ID.

Request body

namestring required

Sheet name. Not required to be unique within a workflow.

auto_runboolean

When true (default), the sheet's action chain runs automatically whenever new data rows arrive — via Add Data Rows or via a send_to_sheet action on another sheet. When false, runs must be triggered explicitly with Run Rows.

cache_enabledboolean

When true (default), a row with input column values identical to a previously-run row reuses the previous row's outputs instead of re-running the action chain. Set to false to always re-run.

cache_sincestring date

Earliest date (YYYY-MM-DD, UTC) from which cached runs are considered fresh. Ignored when cache_enabled is false. Default: null — all cached runs are considered fresh regardless of age.

continue_on_failboolean

When true, a row keeps moving to the next action after an action fails on it. When false (default), the row stops at the failing action. Every action follows this setting unless it has its own continue_workflow_if_action_fails.

Example request

{
  "name": "Employees",
  "cache_since": "2026-03-17"
}

Response

Default Response

statusinteger

Example response

{
  "data": {
    "sheet_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
    "workflow_id": "531952c2-3d07-4be2-8c4b-733acba3187b",
    "name": "Employees",
    "cache_since": "2026-03-17"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.