POST
/
api
/
v1
/
insights
/
workflows
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.create({
    name: "<value>",
    description: "yuck vice between gee ugh ha",
    insightToolIds: [
      780486,
      760259,
      219974,
    ],
    conditions: {},
    status: "<value>",
  });

  // 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

Syllable-API-Key
string
header
required

Body

application/json
name
string
required

Human readable name of Insight Workflow

description
string
required

Text description of Insight Workflow

insight_tool_ids
integer[]
required

List of Insight Tool IDs

conditions
object
required

Conditions for Insight Workflow

status
string
required

Status of the Insight Workflow

Response

200
application/json
Successful Response
name
string
required

Human readable name of Insight Workflow

description
string
required

Text description of Insight Workflow

insight_tool_ids
integer[]
required

List of Insight Tool IDs

conditions
object
required

Conditions for Insight Workflow

status
string
required

Status of the Insight Workflow

id
integer
required

Unique ID for Insight Workflow

insight_tools
object[]
required

List of Insight Tools

last_updated_by
string
required

User who last updated Insight Workflow

created_at
string

Timestamp of Insight Workflow creation

updated_at
string

Timestamp of Insight Workflow update