Apps

This route executes your app and returns the output of each block that was executed.

Required attributes

Optional attributes

Response Body

Streaming

Overview

Streaming enables client-side applications to receive live updates of your application's output as it executes. By setting the streaming attribute to true, your application will generate Server-Sent Events (SSE) that the client can monitor. Learn more about Server-Sent Events here.

Event Types

Your application can generate the following named events:

1. Message Event: This event is activated whenever a block in your application produces an output.
   • Usage: For example, in a text generation block, an event is emitted for every generated token. In a collection search block, an event is triggered once the search is complete.
   • Data Format: The event.data attribute contains a JSON object representing the block's output. For a text generation block named 'output', the text can be found at JSON.parse(event.data).output.output.
   • Completion Signal: The event.data will equal "DONE" when the application run is complete, indicating the end of the process.
2. Start Message Event: This optional event can be set up in the block settings within the dashboard. It is useful for showing a custom message to the user when a block starts execution.
   • Data Content: The event.data attribute will include the start message set for the block.
3. Error Event: This event is activated if an error occurs during application execution.
   • Error Details: The event.data will contain the error message.

Implementation Example

To handle SSE in your application, you can use libraries like sse.js. Below is a JavaScript example showing how to consume these events:

const { SSE } = require('sse.js')

const source = new SSE('<https://api.scoutos.com/v1/flow/execute>', {
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer SECRET_KEY`,
  },
  payload: JSON.stringify({
    "inputs": {
      "input": "What is scout?"
    }
  }),
})

source.addEventListener('message', function (event) {
  if (event.data === '[DONE]') {
    console.log('Execution complete!')
    return
  }

  const payload = JSON.parse(event.data)
  const blockName = Object.keys(payload)[0]
  const result = payload[blockName].output

  console.log('Block Output:', result)
})

source.addEventListener('start_message', function (event) {
  console.log('Start Message:', event.data)
})

source.addEventListener('error', function (event) {
  console.log('Error:', event.data)
})