POST
/
apis
/
request
/
workflow
/
step
/
run
/
{id}
curl --request POST \
--url https://api.nfig.ai/apis/request/workflow/step/run/<id> \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
 "step": "<step>",
 "type": "<stepType>",
 "schema": {
 "<openapi-schema>"
 }
}'
{
  "stepId": "<string>",
  "jobTaskId": "<string>"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
id
string
required

Unique identifier for each workflow session

Body

application/json
​
step
string
required

Step to be executted

​
type
enum<string>
required

Whether it is an ASK or ACT method

Available options:
ACT,
ASK
​
schema
object

open ai compatable schema for structured output

Response

200 - application/json
Create a workflow step run
​
stepId
string
required

Workflow executed step id

​
jobTaskId
string
required

Workflow session job id

Create a step workflow sessionGet completion status of individual step