Skip to main content
POST
/
api
/
workflows
/
submit
Submit Workflow
curl --request POST \
  --url https://api.example.com/api/workflows/submit \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflows": [
    {}
  ],
  "metadata": {},
  "version": "1.0"
}
'
{
  "id": "<string>",
  "client_id": "<string>",
  "owner_id": "<string>",
  "file_id": "<string>",
  "metadata_json": {},
  "status": "PENDING",
  "total_tasks": 123,
  "completed_tasks": 123,
  "start_time": 123,
  "update_time": 123,
  "end_time": 123
}

Headers

Authorization
string
required

Body

application/json
workflows
Workflows · object[]
required

Workflow definition

metadata
Metadata · object

Additional metadata

version
string | null
default:1.0

Version of the workflow

Response

OK

Response of Workflow Status

id
string
required
client_id
string
required
owner_id
string
required
file_id
string
required
metadata_json
Metadata Json · object
required
status
enum<string>
required

Workflow Status Enum

Available options:
PENDING,
RECEIVED,
STARTED,
PROGRESS,
SUCCESS,
FAILURE,
REVOKED
total_tasks
integer
required
completed_tasks
integer
required
start_time
integer | null
update_time
integer | null
end_time
integer | null