Skip to main content
POST
/
api
/
v1
/
insights
/
workflows
/
queue-work
Typescript (SDK)
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.queueWork({
    workflowName: "summary-workflow",
    sessionIdList: [
      12334,
      23445,
      34556,
    ],
    fileIdList: [
      1234,
      1678,
      2224,
    ],
  });

  console.log(result);
}

run();
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Session identifier for workflow queue.

workflow_name
string
required

Unique name for workflow

Example:

"summary-workflow"

session_id_list
integer[] | null

List of session identifiers

Example:

"[12334,23445,34556]"

file_id_list
integer[] | null

List of file IDs to be processed. This is only applicable for upload folders

Example:

"[1234,1678,2224]"

Response

Successful Response