Create Workflow Definition
Create a new workflow definition (template).
Workflow definitions are the deployed pipeline templates that can be configured with custom settings, schedules, and triggers.
This endpoint is typically used by administrators to define new workflow types.
Required:
name: Human-readable workflow nameworkflow_type: Type of workflow (generate-pii-tags, generate-dq-tags, etc.)data_asset_types: List of supported data asset types
Optional:
description: Workflow descriptiondefault_config: Default configuration for this workflow typeis_active: Whether the workflow is active (default: true)
Documentation Index
Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.
Body
Request body for creating a workflow definition.
Human-readable workflow name
1 - 255"Table Profiling Workflow"
"PII Detection Workflow"
Type of workflow
generate-table-description, generate-pii-tags, generate-dq-tags, generate-sensitivity-tags, enrich-table-columns, service-ingestion, profiling, dq-rule-generation, dq-execution, metadata-assessment, dq-assessment, dq-tag-generation, intelligence, metadata-enrichment, run-all-enrichment "generate-pii-tags"
"generate-dq-tags"
"generate-table-description"
Workflow category for grouping
ingestion, enrichment, data_quality, assessment, intelligence "enrichment"
"data_quality"
"assessment"
"ingestion"
List of supported data asset types
["table"]["table", "topic"]Optional workflow description
"Profiles table schema and data quality"
Default configuration for this workflow type
Whether the workflow is active and available for use
Response
Successful Response
Response for workflow definition operations.
Inherits common fields from WorkflowDefinitionBaseFields.
Unique workflow definition identifier
"123e4567-e89b-12d3-a456-426614174001"
Workflow name
"Generate PII Tags"
Type of workflow
generate-table-description, generate-pii-tags, generate-dq-tags, generate-sensitivity-tags, enrich-table-columns, service-ingestion, profiling, dq-rule-generation, dq-execution, metadata-assessment, dq-assessment, dq-tag-generation, intelligence, metadata-enrichment, run-all-enrichment "generate-pii-tags"
Workflow category
ingestion, enrichment, data_quality, assessment, intelligence "enrichment"
Supported data asset types
["table"]Whether workflow is active
true
Creation timestamp (ISO 8601)
"2024-01-01T00:00:00Z"
Workflow description
"Detects and tags PII data in tables"
Default configuration
{ "confidence_threshold": 0.8 }