Hyperflow HUB
Templates
Documentation
API Docs
AI Reports

↩ API Docs

Custom AI Services APIs

Use this API to make synchronous and asynchronous calls to Custom AI Services

REST APIs (Sync)
Webhook REST APIs (async)
REST APIs (Sync)
Follow the below instructions to make a call to Custom AI Services and synchronously receive the AI Service response.
Inputs
Input query parameters
input
required
input
Example of Rest API Call
curl https://{{ tenant }}.lightenup.ai/customaiservice/{serviceName} \
--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
{      
  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
  },
  body: {
       'output1': 'output 1 response',
       'output2': 'output 2 response',     
 }
}      
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 this service"}
}

‍
Webhook REST APIs (async)
Additionally, Custom AI Services can be invoked using the Webhook endpoint for long running AI Services.
The process of initiating an AI Service execution and retrieve its status and final resullt is composed by 2 Steps:


Step1: Initiate AI Service execution.
Step2: Polling for execution status.

Step 1: Initiate an AI Service execution

Make a call to this REST API to make a call to initiate a Custom AI Services execution and retrieve the execution id that will be used in Step 2 to retrieve the AI Service status
Inputs
Input query parameters
input 1
required
input 1
input 2
required
input 2
input n
required
input n
Example of Rest API Call
curl https://{{ tenant }}.lightenup.ai/webhook/customaiservice/{serviceName}\
--request POST \
--header "Authorization: Bearer {access_token}" \
--header "Content-Type: application/json" \
--data @- << EOF
{
  "input1": "input text 1",
  "input2": "input text 2",
..
  "inputn": "input text n"
}
EOF
Responses
Response Code
200
Example of 200 response code
{
   "outputs": [
       {
           "execution_id": "80e49440-33e4-45f5-9e7e-3504cffa86ff"
       }
   ],
   "service": "cinema_users_segmentation"
}
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 this service"}
}

‍


Step 2: Polling

Retrieve a running Custom AI Service status by execution id
Inputs
Input query parameters
execution_id
required
execution_id from Step 1
opCode
required
exec_logs
Example of Rest API 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 from step 1}",
  "opCode": "exec_logs"
}
EOF
Responses
Response Code
200
Example of 200 response code
[   
 {       
       "count": "1", 
      "service": "translation", 
      "service_type": "ai_services",
        "execution_id": "b821a9a9-870c-4f5a-9e51-f01099049271",
        "identity": "employee_assistant",
        "stop_execution": "2025-08-05T03:18:40.161Z",
        "status": "completed", 
      "latency": {           
            "seconds": 1, 
          "milliseconds": 232
        },
        "hyperflow_id": "NA",
        "results": [
           {
               "userid": "12345",
               "username": "jon",
               "firstname": "Jon",
               "lastname": "Doe",
               "email": "jon.doe@example.com",
               "registrationdate": "2020-01-15",
               "membershipstatus": "Active",
               "preferredgenre": "Action",
               "favoritemovie": "Inception",
               "movieswatched": "150",
               "lastlogindate": "2023-10-10",
               "itemspurchased": "20",
               "location": "New York, NY",
               "birthdate": "1990-05-24",
               "gender": "Male",
               "cinemavisitsthismonth": "5",
               "cinemavisitsthisyear": "60",
               "lifetimecinemavisits": "200",
               "toppurchaseditem": "Popcorn",
               "mostactivedaypoints": "Friday",
               "points": "1500"
           }
   ],
 }
]
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
       },
       500,
      {"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 this service"}
}

‍
Copyright © 2025 LIGHTENUP AI SERVICES Ltd.