API Reference
API Reference

Current Insight Workflow Results

Latest execution per workflow/input, with typed step outcomes and explicit absence.

Use this contract for conditional workflows; legacy /insights flattened values cannot represent skipped steps, repeated tools or multiple workflow scopes.

GET/api/v1/insights/workflow-results

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

Query parameters

session_id integer | null query optional
upload_file_id integer | null query optional
workflow_id integer | null query optional
limit integer query optional
Default 100Minimum 1Maximum 1000Example 100
offset integer query optional
Default 0Minimum 0Example 0

Responses

200Successful Response

application/json

response object[] required
Item schema
itemsobjectrequired
Response example
[
  "string"
]
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"
    }
  ]
}