Learn how to run and interact with workflows using the Cortex API and SDKs.
result
property plays a central role in API interactions. In your workflow’s final code step, any data you return in the result
property becomes the main output received when calling the workflow via API:
result
object will be directly accessible in the API response.
result
property works:
result
property, it becomes the API responseresult
property exists, the entire output of the last step becomes the API responseresult
property that has a fields
property containing the extracted data.
Now, let’s deploy the workflow and run it via API. Before you can access your workflow through the API, you need to deploy it first:
result
, which contains the direct output from your workflow’s final code step.
input
object you provide when running a workflow corresponds to the fields you’ve defined in your workflow’s input steps. The structure is based on the field you defined in the input step:
For example, if your input step has fields like:
Your API input would look like:
input
object, several additional parameters enable more granular control: