Flow Trigger Endpoints

Use the /run and /webhook endpoints to run flows.

To create, read, update, and delete flows, see Flow management endpoints.

Run flow

Points to note

Robility flow automatically generates Python, JavaScript, and curl code snippets for the /v1/run/$FLOW_ID endpoint for all flows. For more information, see Generate API code snippets.

Execute a specified flow by ID or name. Flow IDs can be found on the code snippets on the API access pane or in a flow’s URL.

The following example runs the Basic Prompting template flow with flow parameters passed in the request body. This flow requires a chat input string (input_value) and uses default values for all other parameters.

curl -X POST \

  “$ROBILITY FLOW_SERVER_URL/api/v1/run/$FLOW_ID” \

  -H “Content-Type: application/json” \

  -H “x-api-key: $ROBILITY FLOW_API_KEY” \

  -d ‘{

    “input_value”: “Tell me about something interesting!”,

    “session_id”: “chat-123”,

    “input_type”: “chat”,

    “output_type”: “chat”,

    “output_component”: “”,

    “tweaks”: null

  }’

The response from /v1/run/$FLOW_ID includes metadata, inputs, and outputs for the run.

If you are parsing the response in an application, you most likely need to extract the relevant content from the response, rather than pass the entire response back to the user. For an example of a script that extracts data from a Robility flow API response, see the Quickstart.

Stream LLM token responses

With /v1/run/$FLOW_ID, the flow is executed as a batch with optional LLM token response streaming.

To stream LLM token responses, append the ?stream=true query parameter to the request:

curl -X POST \

  “$ROBILITY FLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=true” \

  -H “accept: application/json” \

  -H “Content-Type: application/json” \

  -H “x-api-key: $ROBILITY FLOW_API_KEY” \

  -d ‘{

    “message”: “Tell me something interesting!”,

    “session_id”: “chat-123”

  }’

LLM chat responses are streamed back as token events, culminating in a final end event that closes the connection.

Result

Run endpoint headers