FLflorafauna-ai
Canvas

Run a canvas action

Changed on

Runs an existing canvas action node, prebuilt or custom, through the action execution workflow. Pass params to update the node's stored parameter values first; the run uses the merged values.

post/projects/{projectId}/actions/{nodeId}/run

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/projects/{projectId}/actions/{nodeId}/run
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier

Example:prj_abc123
nodeIdstring required

Canvas action node identifier: the persisted short id (n7) or the node UUID

Request body

paramsobject

Parameter values to store on the node before running, merged key by key into the values it already holds (a named key is overwritten, omitted keys survive). Keys as GET /projects/{projectId}/actions/{nodeId} lists them.

stateunknown

Response

Canvas action run started.

run_idstring required

Run identifier

type'generation' | 'technique' | 'action' required

Run type

estimated_secondsinteger nullable required
charged_costnumber required

Cost in USD. For a generation run, the list price of this request's parameters before any plan discount, and an estimate for usage-priced models; when the request cannot be priced in time, the model's price at default settings. GET /runs/{run_id} reports the settled amount once the run completes.

poll_urlstring uri nullable

URL to poll pending/running runs or fetch completed/failed run details.

project_idstring nullable

Project identifier

canvas_urlstring uri nullable

Link to the project canvas. Hand this to the user as-is; a URL built from project_id does not resolve.

Example response

{
  "run_id": "run_abc123",
  "model": {
    "model_id": "t2i-flux-2-pro"
  },
  "technique": {
    "technique_id": "tech_abcd1234"
  },
  "action": {
    "action_id": "color-grade-image-browser"
  },
  "project_id": "prj_abc123"
}

Changes

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

  • e54130373b10Revision changes
    • warning

      added the new add-shape-to-image-browser enum value to the // response property for the response status

    • warning

      added the new add-text-to-image-browser enum value to the // response property for the response status

    • warning

      added the new blur-image-browser enum value to the // response property for the response status

    • warning

      added the new change-image-ar-browser enum value to the // response property for the response status

    • warning

      added the new color-filter-image-browser enum value to the // response property for the response status

    • warning

      added the new color-grade-image-browser enum value to the // response property for the response status

    • warning

      added the new color-tint-image-browser enum value to the // response property for the response status

    • warning

      added the new concat-text-browser enum value to the // response property for the response status

    • warning

      added the new crop-image-browser enum value to the // response property for the response status

    • warning

      added the new draw-image-browser enum value to the // response property for the response status

    • warning

      added the new duplicate-image-browser enum value to the // response property for the response status

    • warning

      added the new filter-color-image-browser enum value to the // response property for the response status

    • warning

      added the new find-and-replace-text-browser enum value to the // response property for the response status

    • warning

      added the new magic-eraser-image-browser enum value to the // response property for the response status

    • warning

      added the new overlay-image-browser enum value to the // response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new paid_plan_required enum value to the / response property for the response status

    • warning

      added the new pixel-remover-image-browser enum value to the // response property for the response status

    • warning

      added the new qr-code-generator-browser enum value to the // response property for the response status

    • warning

      added the new resize-image-browser enum value to the // response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new revision_conflict enum value to the / response property for the response status

    • warning

      added the new rotate-image-browser enum value to the // response property for the response status

    • warning

      added the new scene-3d-image-browser enum value to the // response property for the response status

    • warning

      added the new shader-effect-browser enum value to the // response property for the response status

    • warning

      added the new side-by-side-composite-browser enum value to the // response property for the response status

    • warning

      added the new split-text-browser enum value to the // response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • warning

      added the new temporarily_unavailable enum value to the / response property for the response status

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the add-shape-to-image enum value from the // response property for the response status

    • info

      removed the add-text-to-image enum value from the // response property for the response status

    • info

      removed the blur-image enum value from the // response property for the response status

    • info

      removed the change-image-ar enum value from the // response property for the response status

    • info

      removed the color-filter-image enum value from the // response property for the response status

    • info

      removed the color-grade-image enum value from the // response property for the response status

    • info

      removed the color-tint-image enum value from the // response property for the response status

    • info

      removed the concat-text enum value from the // response property for the response status

    • info

      removed the duplicate-image enum value from the // response property for the response status

    • info

      removed the filter-color-image enum value from the // response property for the response status

    • info

      removed the find-and-replace-text enum value from the // response property for the response status

    • info

      removed the flip-image enum value from the // response property for the response status

    • info

      removed the generate-shape-image enum value from the // response property for the response status

    • info

      removed the generate-text-image enum value from the // response property for the response status

    • info

      removed the qr-code-generator enum value from the // response property for the response status

    • info

      removed the rotate-image enum value from the // response property for the response status

    • info

      removed the side-by-side-composite enum value from the // response property for the response status

    • info

      removed the split-text enum value from the // response property for the response status