curl --request POST \
--url https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"asset_fqn": "PostgreSQL.dvdrental.public",
"parameters": {
"include": [
"PostgreSQL.dvdrental.public.actor"
],
"industry_info": "Banking and financial services"
}
}
'import requests
url = "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs"
payload = {
"asset_fqn": "PostgreSQL.dvdrental.public",
"parameters": {
"include": ["PostgreSQL.dvdrental.public.actor"],
"industry_info": "Banking and financial services"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
asset_fqn: 'PostgreSQL.dvdrental.public',
parameters: {
include: ['PostgreSQL.dvdrental.public.actor'],
industry_info: 'Banking and financial services'
}
})
};
fetch('https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'asset_fqn' => 'PostgreSQL.dvdrental.public',
'parameters' => [
'include' => [
'PostgreSQL.dvdrental.public.actor'
],
'industry_info' => 'Banking and financial services'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs"
payload := strings.NewReader("{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}"
response = http.request(request)
puts response.read_body{
"asset_fqn": "PostgreSQL.dvdrental.public.customer",
"configuration_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174002",
"save_all": true,
"schema_fetch_skipped": false,
"started_at": "2024-01-15T10:30:00Z",
"status": "pending",
"stripped_parameters": []
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}Create Workflow Run
Trigger a new run of a workflow by configuration ID.
This creates a workflow run record and triggers the associated Prefect deployment in fire-and-forget mode. The run status can be monitored via the get/list endpoints.
Headers:
Authorization: Bearer token with JWT for authenticationX-Project-ID: Project resource URI (e.g., ‘proj:customer-analytics’)
Optional:
asset_fqn: Fully qualified name of the data asset (e.g., ‘PostgreSQL.dvdrental.public.customer’)parameters: Additional workflow execution parameters. For generate-table-description, use ‘include’ to specify a list of table FQNs to process.
curl --request POST \
--url https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"asset_fqn": "PostgreSQL.dvdrental.public",
"parameters": {
"include": [
"PostgreSQL.dvdrental.public.actor"
],
"industry_info": "Banking and financial services"
}
}
'import requests
url = "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs"
payload = {
"asset_fqn": "PostgreSQL.dvdrental.public",
"parameters": {
"include": ["PostgreSQL.dvdrental.public.actor"],
"industry_info": "Banking and financial services"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
asset_fqn: 'PostgreSQL.dvdrental.public',
parameters: {
include: ['PostgreSQL.dvdrental.public.actor'],
industry_info: 'Banking and financial services'
}
})
};
fetch('https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'asset_fqn' => 'PostgreSQL.dvdrental.public',
'parameters' => [
'include' => [
'PostgreSQL.dvdrental.public.actor'
],
'industry_info' => 'Banking and financial services'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs"
payload := strings.NewReader("{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"asset_fqn\": \"PostgreSQL.dvdrental.public\",\n \"parameters\": {\n \"include\": [\n \"PostgreSQL.dvdrental.public.actor\"\n ],\n \"industry_info\": \"Banking and financial services\"\n }\n}"
response = http.request(request)
puts response.read_body{
"asset_fqn": "PostgreSQL.dvdrental.public.customer",
"configuration_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174002",
"save_all": true,
"schema_fetch_skipped": false,
"started_at": "2024-01-15T10:30:00Z",
"status": "pending",
"stripped_parameters": []
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}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.
Path Parameters
Configuration ID
"550e8400-e29b-41d4-a716-446655440001"
Body
Request body for creating/triggering a workflow run.
The parameters field accepts workflow-specific options. Common parameters include:
Enrichment Workflows (generate-pii-tags, generate-table-description, enrich-table-columns):
include: List of specific table FQNs to process (required for generate-table-description)industry_info: Industry context for domain-specific enrichment (e.g., "Banking", "Healthcare", "E-commerce")
DQ Workflows (generate-dq-tags, generate-dq-rules, dq-execution):
industry_info: Industry context for domain-specific tagging (e.g., "Banking", "Healthcare") — generate-dq-tags onlyuse_validation: Whether to validate generated SQL rules (default: true) — generate-dq-rules only- Note:
resource_urianddatabase_typeare derived internally from the asset FQN, org_id, and project_id
Profiling Workflow:
config.profile_all_databases: Profile all databases in the serviceconfig.database: Single database name to profileconfig.parallel_workers: Concurrent column queries per table (default: 10)config.sample_data_limit: Number of sample values per column (default: 5)
Fully qualified name of the data asset for the workflow run (e.g., 'PostgreSQL.dvdrental.public.customer').
"PostgreSQL.dvdrental.public"
Workflow-specific execution parameters. See class docstring for available options per workflow type.
{
"include": [
"PostgreSQL.dvdrental.public.actor",
"PostgreSQL.dvdrental.public.film"
],
"industry_info": "E-commerce retail platform"
}
When true, workflow results are auto-saved without requiring manual approval.
Response
Successful Response
Response for workflow run creation.
Created run identifier
"123e4567-e89b-12d3-a456-426614174002"
Workflow configuration ID
"123e4567-e89b-12d3-a456-426614174000"
Initial run status
"pending"
Run start timestamp (ISO 8601)
"2024-01-15T10:30:00Z"
Fully qualified name of the data asset
"PostgreSQL.dvdrental.public.customer"
Whether workflow results are auto-saved without requiring manual approval.
true
PipelineRun ID for run-all-enrichment orchestrator runs
Parameter keys that were stripped before triggering the flow because the flow's Prefect schema does not declare them. Non-empty only when the caller passes parameters the flow ignores (e.g. 'include', 'industry_info' for assessment flows). Empty list also when schema_fetch_skipped=True — see that field to distinguish.
True when the Prefect deployment schema could not be fetched due to a transient connectivity error and parameters were forwarded unchanged without filtering. When True, stripped_parameters is always empty even if the flow would have rejected some parameters.
Was this page helpful?

