Queue Insights Workflow For Sessions/Files

Manually queue sessions for insights workflow evaluation.

POST/api/v1/insights/workflows/queue-work

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

application/json

body InsightsWorkflowQueueSession required

3 fields

workflow_namestringrequired

Unique name for workflow

session_id_listinteger[] | nulloptional

List of session identifiers

Item schema

itemsintegerrequired

file_id_listinteger[] | nulloptional

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

Item schema

itemsintegerrequired

Request example

{
  "workflow_name": "string",
  "session_id_list": "string",
  "file_id_list": "string"
}

Responses

200Successful Response

application/json

response unspecified required

Response example

string

400Bad Request

No response body is declared.

404Not Found

No response body is declared.

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

500Internal Server Error

No response body is declared.

Code examples

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.insights.workflows.queueWork({
    workflowName: "summary-workflow",
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.insights.workflows.queue_work(request={
        "workflow_name": "summary-workflow",
    })

    # Handle response
    print(res)

curl --request POST \
  --url 'https://api.syllable.cloud/api/v1/insights/workflows/queue-work' \
  --header 'content-type: application/json' \
  --data '{
  "workflow_name": "string",
  "session_id_list": "string",
  "file_id_list": "string"
}'