Install a recipe into the workspace

Changed on

Copies the recipe's workflow, and the templates its steps use, into the API key's team, and returns the new workflow. Trial accounts are capped at 3 workflows — installing beyond the cap returns 402.

post/recipes/{id}/install

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Path parameters

idstring required

Recipe uid or slug

Response

Installed

uidstring
namestring
descriptionstring nullable
tagsstring[]
inputsobject

Inputs this workflow accepts, keyed by name. Each value is { type, required }. url-typed inputs are validated as http(s) URLs when a run is created.

ui_write_access'owner_only' | 'team'
api_write_access'team' | 'owner_only' | 'nobody'

Who may run this workflow via the API

created_atstring date-time

Changes