Home
Hyperflows
AI Services
Resources
Applications
AI Reports

↩ API Docs

Hyperflow APIs

The Hyperflow APIs expose a variety of services that trigger the orchestration of coordinated AI services which empower users to build complex AI-powered applications

Async Rest API (Webhook)
Websocket API
REST API

Async Rest API (Webhook)

Follow this 2-step process to access to the Hyperflow API with Webhook HTTPS communication:
‍
Step 1: Execute the Hyperflow and retrieve the execution_id
Step 2: Polling and retrieve Hyperflow steps results

Step 1: Execute the Hyperflow and retrieve the execution_id

Inputs
Input body json payload
{input 1}
optional
Input 1
{input 2}
optional
Input 2
{input n}
optional
Input n
Example of Async REST API with Webhook call
curl https://{{ tenant }}.lightenup.ai/hyperflow/{hyperflowName} \
--request POST \
--header "Authorization: Bearer {access_token}" \
--header "Content-Type: application/json" \
--data @- << EOF
{
  "input 1": "input text 1",
   "input 2": "input text 2",
   ...
  "input n": "input text n",
}
EOF
Responses
Response Code
200
Example of 200 response code
{
   "hyperflowId": "3febbd7d-86a6-408e-97d9-12f32c72d66b",
   "executionId": "IXBEHH6NiGYEXvA="
}
Response Code
400
Example of 400 error
{      
       headers: {
           'Content-Type': 'application/json',
           'Access-Control-Allow-Headers': '*',
           'Access-Control-Allow-Methods': allowMethods,
          'Access-Control-Allow-Origin': GLOBALS.CORS_ORIGIN,
           'Access-Control-Allow-Credentials': true
       },
       400,
      {"message":"Missing parameters"},
      Error: "CustomError",
      Cause: {"errorType": "CustomError", "errorMessage": "Missing parameters"}
}
Response Code
500
Example of 500 error
{      
       headers: {
           'Content-Type': 'application/json',
           'Access-Control-Allow-Headers': '*',
           'Access-Control-Allow-Methods': allowMethods,
          'Access-Control-Allow-Origin': GLOBALS.CORS_ORIGIN,
           'Access-Control-Allow-Credentials': true
       },
       500,
      {"message":"Internal server: error processing intake step"},
      Error: "CustomError",
      Cause: {"errorType": "CustomError", "errorMessage": "Internal server: error
processing intake step"}
}


Step 2: Polling

Inputs
Input body json payload
execution_id
optional
execution_id value from Step 1
opCode
optional
exec_logs
Example of Async REST API with Webhook call
curl https://{{ tenant }}.lightenup.ai/admin/stats \
--request POST \
--header "Authorization: Bearer {access_token}" \
--header "Content-Type: application/json" \
--data @- << EOF
{
  "execution_id": "{execution_id}",
   "opCode": "exec_logs"
}
EOF


Responses
Response Code
200
Example of 200 response code
[
   {
       "count": "1",
       "service": "privacy_risk",
       "service_type": "ai_services",
       "execution_id": "b89418fa-88ac-42b7-bf79-603d7e8edac5",
       "identity": "employee_assistant",
       "stop_execution": "2025-04-01T19:24:45.848Z",
       "status": "completed",
       "latency": {
           "milliseconds": 899
       },
       "hyperflow_id": "NA"
   },
...
   {
       "count": "1",
       "service": "sentiment_analysis",
       "service_type": "ai_services",
       "execution_id": "8a9b84af-e058-42a1-bb89-a357f1093373",
       "identity": "employee_assistant",
       "stop_execution": "2025-04-01T19:24:48.504Z",
       "status": "completed",
       "latency": {
           "seconds": 1,
           "milliseconds": 482
       }
   }
]
Response Code
200
Example Missing parameters
[
    {
        "service_type": "custom_ai_services",
        "execution_id": "fcc3376f-df13-4e04-896b-8c16d1392b11",
        "hyperflow_execution_id": "fcc3376f-df13-4e04-896b-8c16d1392b11", 
      "hyperflow_node_id": "NA",
        "service": "access_control_api", 
      "answer": "Missing Parameters",
        "start_execution": "2025-08-05T04:03:04.996Z", 
      "stop_execution": "2025-08-05T04:03:05.045Z",
        "status": "error",
        "inputs": "{\"inputsValues\":{\"employee_name\":\"Ashley\",\"service\":\"access_control_api\",\"websocket\":{\"messageId\":\"fcc3376f-df13-4e04-896b-8c16d1392b11\"}}}"    }
]
Back to the top

Hyperflow Websocket API

Hyperflow API via Websocket connection.

Step 1: Connect

Inputs
Input body json payload
access_token
optional
Access token
Example of Websocket authentication
Endpoint: wss://ws.{{ tenant }}.lightenup.ai?Authorization={access_token}
Responses
Response Code
200


First, confirm that it is running by receiving “ack”

Example of Successful response 200 OK
{
   "action": "message",
   "state": "ack",
   "statusCode": "200",
   "service_type": "customhyperflow",
   "service": "customhyperflow_customer_portal_ticket",
   "connectionId": "ITeEycoRiGYCE8w=",
   "messageId": "ITeFwcorCGYCE8w=",
   "message": "Request received and being processed",
   "inputsValues": "{}",
   "nodeId": ""
}
Response Code
403
Example of 403 error
Request Method: GET
Status Code: 403 Forbidden


Step 2: Send service specific message

Inputs
Input body json payload
service
optional
Input service name
action
optional
Input action
{input n}
optional
input n
Example of Websocket call
‍Endpoint: wss://ws.{{ tenant }}.lightenup.ai. \
message
{
  "service": "customhyperflow_assistant_hitl",
  "action": "message",  
   ...  
  "{input n}": "{input text n}"
}
EOF‍
Responses
Response Code
200
Example of Successful response 200 OK
{
   "action": "message",
   "state": "completed",
   "statusCode": "200",
   "service_type": "custom_ai_services",
   "service": "cinema_promotion_visits_month",
   "connectionId": "ITeEycoRiGYCE8w=",
   "messageId": "ITeFwcorCGYCE8w=",
   "message": "{\"outputs\":{\"results\":[{\"promotionactivated\":\"No\", \"execution_id\":\"0158e363-ad8c-42c9-a2de-57254b3e461f\"}}", "inputsValues": "{\"inputsValues\":{\"useremail\":\"jdoe@example.com\",
\"role\":\"c56d724e-df0c-4938-8fd2-fd88f735acfb\"}}",
   "nodeId": "plJLovz_tvtOq_Nza9_Rq"
}
Response Code
403
Example of 403 error
Request Method: GET
Status Code: 403 Forbidden
Back to the top