Workflows

Create Workflow

Changed on

Create a new workflow.

Request Body: - name: Workflow name - description: Optional description - workflow_type: Type of workflow (extract, fill, split, etc.) - nodes: List of workflow nodes - edges: List of workflow edges - is_template: Whether this is a reusable template - metadata_json: Additional metadata

Returns: Created workflow

post/api/workflows

Request

  • Base URL
    https://api.qomplement.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.qomplement.com/api/workflows
  • Auth
    HTTP bearer

Query parameters

organization_idstring nullable

Request body

namestring required
descriptionstring nullable
workflow_typestring required
is_templateboolean
metadata_jsonobject nullable
project_idstring nullable

Response

Successful Response

idstring required
user_idstring required
namestring required
descriptionstring nullable required
workflow_typestring required
nodesobject[] required
edgesobject[] required
is_activeboolean required
is_templateboolean required
last_executed_atstring nullable required
last_execution_statusstring nullable required
execution_countinteger required
created_atstring required
updated_atstring required
metadata_jsonobject required
project_idstring nullable
has_dashboardboolean

Changes

    • info

      added the new optional query request parameter organization_id

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status