agents
agents.test
conversations
data_sources
events
insights.workflows
insights.tools
custom_messages
prompts
session_labels
sessions.transcript
sessions.summary
sessions.full-summary
channels.targets
directory
dashboards
outbound.batches
- GETList Outbound Communication Batches
- PUTCreate Outbound Communication Batch
- GETGet Outbound Communication Batch
- DELDelete Outbound Communication Batch
- POSTUpload Outbound Communication Batch
- GETFetch Outbound Communication Batch Results
- POSTCreate Outbound Communication Request
- POSTDelete Requests By List Of Reference Ids
outbound.campaigns
Get Insight Workflow By Id
Get a InsightWorkflow by ID.
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.insights.workflows.getById({
workflowId: 931598,
});
// Handle the result
console.log(result);
}
run();
{
"name": "<string>",
"description": "<string>",
"insight_tool_ids": [
123
],
"conditions": {},
"status": "<string>",
"id": 123,
"insight_tools": [
{
"name": "<string>",
"description": "<string>",
"version": 123,
"tool_arguments": {},
"insight_tool_definition_id": 123,
"id": 123,
"insight_tool_definition": {
"id": 123,
"name": "<string>",
"type": "<string>",
"description": "<string>",
"tool_parameters": {},
"tool_result_set": {}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>"
}
Authorizations
Path Parameters
Response
Human readable name of Insight Workflow
Text description of Insight Workflow
List of Insight Tool IDs
Conditions for Insight Workflow
Status of the Insight Workflow
Unique ID for Insight Workflow
List of Insight Tools
Human readable name of Insight Tool
Text description of Insight Tool
Version of Insight Tool
Arguments for Insight Tool
Unique ID for Insight Tool Definition
Unique ID for Insight Tool
User who last updated Insight Tool
Insight Tool Definition
Unique ID for Insight Tool Definition
Human readable name of Insight Tool Definition
Type of Insight Tool Definition
Text description of Insight Tool Definition
Parameters for Insight Tool Definition
Result key/types for Insight Tool Definition
Timestamp of Insight Tool creation
Timestamp of Insight Tool update
User who last updated Insight Workflow
Timestamp of Insight Workflow creation
Timestamp of Insight Workflow update
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.insights.workflows.getById({
workflowId: 931598,
});
// Handle the result
console.log(result);
}
run();
{
"name": "<string>",
"description": "<string>",
"insight_tool_ids": [
123
],
"conditions": {},
"status": "<string>",
"id": 123,
"insight_tools": [
{
"name": "<string>",
"description": "<string>",
"version": 123,
"tool_arguments": {},
"insight_tool_definition_id": 123,
"id": 123,
"insight_tool_definition": {
"id": 123,
"name": "<string>",
"type": "<string>",
"description": "<string>",
"tool_parameters": {},
"tool_result_set": {}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>"
}