What are Workflow Inputs?

Inputs are the values for your workflow's declared inputs, keyed by name. Each input contains the following:

• name - used as references in your workflows and API requests
• type - the type of input you're supplying
  • text (string)
  • url (web url)
  • number (integer)
  • boolean (true/false)
• required - determines whether a run must supply this input

Use the + ref drop-down menu to select the appropriate input for each respective field in your workflow steps.

The API expects a list of "inputs": {"input1", "input2", but they may also be sent as a bare top-level object instead of nested under input.

Nested Inputs

var data = {
  "workflow": "VymBYa7gMjW6JQ2njM",
  "inputs": {
    "video_url": "https://cdn.bannerbear.com/sample_videos/clip.mp4",
    "title_text": "New Arrival"
  }
}
fetch('https://api.bannerbear.com/v5/workflow_runs', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

Bare top-level

var data = {
  "workflow": "VymBYa7gMjW6JQ2njM",
  "video_url": "https://cdn.bannerbear.com/sample_videos/clip.mp4",
  "title_text": "New Arrival"
}
fetch('https://api.bannerbear.com/v5/workflow_runs', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

Check out the API Reference for more: https://developers.bannerbear.com/v5/#workflows