Chat

Build Flow

Changed on

HTTP entry point for the v1 build route: always the interactive_chat family.

The execution family is deliberately NOT a request parameter. It selects the identity connections resolve under, so a caller able to name it could ask for webhook and run under the flow owner's credentials.

post/api/v1/build/{flow_id}/flow

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Path parameters

flow_idstring uuid required

Query parameters

stop_component_idstring nullable
start_component_idstring nullable
log_buildsboolean
flow_namestring nullable
event_delivery'streaming' | 'direct' | 'polling'

Request body

filesstring[] nullable

Example request

{
  "inputs": {
    "components": [
      "components_id",
      "Component Name"
    ],
    "input_value": "input_value",
    "session": "session_id"
  }
}

Response

Successful Response

unknown required

Changes

  • 830c31118215Revision changes
    • info

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

    • info

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

  • 0be341779529Revision changes
    • info

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

    • info

      the endpoint scheme security OAuth2PasswordBearer was removed from the API