GET
/
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.list({});

  // Handle the result
  console.log(result);
}

run();
{
  "items": [
    {
      "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>"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "total_count": 123
}

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

page
integer | null
default:0
Required range: x >= 0
limit
integer
default:25
Required range: x >= 0
search_fields
enum<string>[]
Available options:
id,
name,
description,
status,
conditions,
insight_tool_ids,
updated_at
search_field_values
string[]
order_by
enum<string> | null
Available options:
id,
name,
description,
status,
conditions,
insight_tool_ids,
updated_at
order_by_direction
enum<string> | null
Available options:
asc,
desc
fields
enum<string>[] | null
Available options:
id,
name,
description,
status,
conditions,
insight_tool_ids,
updated_at
start_datetime
string | null
end_datetime
string | null

Response

200
application/json
Successful Response
items
object[]
required
page
integer
required
page_size
integer
required
total_pages
integer | null
total_count
integer | null