Skip to main content
POST
/
v3
/
product-agent-api
/
catalog-workflow
Run catalog enrichment
curl --request POST \
  --url https://commerceos.aiagents.fabric.inc/api/v3/product-agent-api/catalog-workflow \
  --header 'Content-Type: application/json' \
  --header 'domain: <domain>' \
  --data '
{
  "name": "Product Catalog v2",
  "type": "CATALOG_ENRICHMENT",
  "enrichment_configuration": {
    "catalog_scope": "FULL",
    "force_refresh": true,
    "catalog_file_id": "69c178281bf0405f07f02dcd",
    "use_v2_orchestrator": true,
    "brand_guidelines": []
  }
}
'
{
  "id": "69c1784f9184cbdb46675449",
  "tenant_id": "-",
  "domain": "acme.com",
  "created_at": "2026-03-23T17:28:47.903000",
  "updated_at": "2026-03-23T17:28:47.903000",
  "created_by": "692d9d0eb8636aa1286823be",
  "name": "Product Catalog v2",
  "source": "EXTENSION",
  "type": "CATALOG_ENRICHMENT",
  "status": "COMPLETE",
  "step": "FULL_PRODUCT_CATALOG_INITIATED",
  "crawling_configuration": null,
  "enrichment_configuration": {
    "catalog_scope": "FULL",
    "catalog_file_id": "69c178281bf0405f07f02dcd",
    "force_refresh": true,
    "is_citation_enabled": false,
    "include_ads_feed": false,
    "use_v2_orchestrator": true,
    "brand_guidelines": [],
    "factual_feedback": null,
    "additional_attributes": null,
    "concurrency": 10
  },
  "brand_inference_configuration": null,
  "notification": null,
  "last_event_at": "2026-03-23T17:28:47.903841Z",
  "retry_count": 0,
  "max_retries": 3,
  "last_error": null,
  "catalog_scope": "FULL",
  "catalog_file_id": "69c178281bf0405f07f02dcd"
}

Headers

​
domain
string
required

The brand domain or brand identifier used to scope the request to a specific brand’s data and configuration.

Example:

"vessel"

Query Parameters

​
is_temporal
boolean

Whether to run the workflow in temporal mode.

Example:

true

Body

application/json
​
name
string
required

Human-friendly workflow name.

Example:

"Product Catalog v2"

​
type
string
required

Workflow type.

Example:

"CATALOG_ENRICHMENT"

​
enrichment_configuration
object
required

Response

Catalog enrichment workflow created

​
id
string
required

Workflow identifier.

Example:

"69c1784f9184cbdb46675449"

​
tenant_id
string
required
Example:

"-"

​
domain
string
required
Example:

"acme.com"

​
created_at
string<date-time>
required
Example:

"2026-03-23T17:28:47.903000"

​
updated_at
string<date-time>
required
Example:

"2026-03-23T17:28:47.903000"

​
created_by
string
required

Identifier of the user or service that created the workflow.

Example:

"692d9d0eb8636aa1286823be"

​
name
string
required
Example:

"Product Catalog v2"

​
source
string
required
Example:

"EXTENSION"

​
type
string
required
Example:

"CATALOG_ENRICHMENT"

​
status
string
required
Example:

"COMPLETED"

​
step
string
required
Example:

"FULL_PRODUCT_CATALOG_COMPLETED"

​
enrichment_configuration
object
required
​
last_event_at
string<date-time>
required
Example:

"2026-03-20T17:07:39.910225Z"

​
retry_count
integer
required
Example:

0

​
max_retries
integer
required
Example:

3

​
catalog_scope
string
required
Example:

"FULL"

​
catalog_file_id
string
required
Example:

"69bd7e7f476258f0ca961c07"

​
crawling_configuration
object
Example:

null

​
brand_inference_configuration
object
Example:

null

​
notification
object
Example:

null

​
last_error
string | null
Example:

null