Start Workflow
curl --request POST \
--url https://svalync.com/api/workflow/runWorkflow \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"callId": "<string>"
}'{
"response": [
{
"nodeId": "<string>",
"input": {
"name": "<string>",
"imageURL": "<string>",
"description": "<string>",
"loading": true,
"isConnected": true,
"actions": [
[
{
"option": {
"label": "<string>",
"value": "<string>"
},
"inputs": [
[
{
"type": "<string>",
"required": true,
"name": "<string>",
"label": "<string>",
"defaultValue": "<string>",
"value": "<string>",
"options": [
[
{
"label": "<string>",
"value": "<string>"
}
]
]
}
]
],
"responses": {
"batch_id": "<string>",
"isTestMode": true,
"state": "<string>"
},
"action": "<string>",
"type": "<string>",
"msg": "<string>"
}
]
],
"actionEntityAction": "<string>"
},
"response": {
"batch_id": "<string>",
"state": "<string>"
}
}
]
}Authorization
Your Api Key
Params
The workflow id for the user initiating the flow. Click here to know how to get workflow id.
Payload
The payload is dynamic and depends on the first node of the workflow. For instance, if the first node involves voice AI and Get Call Action, the payload should include the necessary input values for these actions.
The unique identifier of the call
Response
The unique identifier for the workflow node.
The name of the app or service.
The URL of the image associated with the app or service.
A brief description of the app or service.
Indicates whether the app or service is currently loading.
Indicates whether the app or service is connected.
The type of input (e.g., text, select).
Indicates whether the input is required.
The name of the input field.
The label for the input field.
The default value for the input field.
The current value of the input field.
The type of action being performed.
The type of the action (e.g., action).
A message providing additional information about the action.
The action being performed by the entity.
curl --request POST \
--url https://svalync.com/api/workflow/runWorkflow \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"callId": "<string>"
}'{
"response": [
{
"nodeId": "<string>",
"input": {
"name": "<string>",
"imageURL": "<string>",
"description": "<string>",
"loading": true,
"isConnected": true,
"actions": [
[
{
"option": {
"label": "<string>",
"value": "<string>"
},
"inputs": [
[
{
"type": "<string>",
"required": true,
"name": "<string>",
"label": "<string>",
"defaultValue": "<string>",
"value": "<string>",
"options": [
[
{
"label": "<string>",
"value": "<string>"
}
]
]
}
]
],
"responses": {
"batch_id": "<string>",
"isTestMode": true,
"state": "<string>"
},
"action": "<string>",
"type": "<string>",
"msg": "<string>"
}
]
],
"actionEntityAction": "<string>"
},
"response": {
"batch_id": "<string>",
"state": "<string>"
}
}
]
}