Sitecore API catalog/Pipeline API/Pipeline

Pipeline

The Pipeline API lets you run the brand ingestion process to analyze uploaded brand documents, break them into knowledge chunks, and store them as brand knowledge. It also supports the enrichment process, which uses brand knowledge to populate brand kit sections and subsections.

Operations

Create a pipeline run for brand ingestion

Request

Creates a new pipeline to run the brand ingestion process. Through this process, brand documents uploaded to a brand kit are processed, analyzed, and chunked into knowledge pieces to create brand knowledge.

To use this endpoint, make sure to upload and process at least one document before running the brand ingestion pipeline.

The brand ingestion process might take a few minutes depending on the file size.

Security
HTTPBearer
Path
organizationIdstring, [ 1 .. 200 ] charactersrequired

The unique identifier of your organization.

To get this value, from the Sitecore Cloud Portal URL, the organizationId is what comes after organization= .

Example:org_ABCDef123456​
Bodyapplication/jsonrequired
parametersobject(BrandIngestionPipelineParameters)required
curl -i -X POST \
  'https://edge-platform.sitecorecloud.io/ai/ai-pipeline-api/api/data/v1/organizations/org_ABCDef123456​/pipeline/BrandIngestionPipeline' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parameters": {
      "brand_kit_id": "98689dd5-1684-48cb-a339-d9610dbd7986",
      "populateSections": true,
      "documentIdsList": "30e73070-5230-4441-a88e-ef72a7d15316,30e73070-5230-4441-a88e-ef72a7d15316"
    }
  }'

Responses

Brand ingestion successfully ran

Bodyapplication/json
createdOnstring or null, (date-time)required

The date and time when the pipeline run was created, formatted in ISO 8601.

Example:"2025-04-23T13:55:13.308326"
createdBystring or nullrequired

The user who created the pipeline run.

Example:"mman"
updatedOnstring or null, (date-time)required

The date and time when the pipeline run was last updated, formatted in ISO 8601.

Example:"2025-04-23T13:55:13.308326"
updatedBystring or nullrequired

The user who last updated the pipeline run.

Example:"mman"
idstringrequired

The unique identifier of the pipeline run.

Example:"e774b4b6-204e-11f0-a62d-3e62ff39b87e"
pipelineIdstringrequired

The name of the pipeline used to run a brand kit process.

Examples: "BrandIngestionPipeline", "EnrichSectionsPipeline".

parametersobjectrequired

The parameters used for brand ingestion, such as brand kit and organization IDs and base URLs.

Example:
{
  "brand_kit_id": "98689dd5-1684-48cb-a339-d9610dbd7986",
  "org_id": "org_ZiiCnzhCeHDpWJAU",
  "baseUrlDocAPI": "https://ai-documents-api-euw.sitecorecloud.io"
}
runStartstring or null, (date-time)required

The date and time when the pipeline run began, formatted in ISO 8601.

Example:"2025-06-18T12:46:12.718310"
runEndstring or null, (date-time)required

The date and time when the pipeline run finished, formatted in ISO 8601.

Example:"2025-06-18T12:46:12.718310"
durationInMsinteger or null

The total duration of the pipeline run in milliseconds.

Default:0
Example:3
statusstring or null

The current status of the pipeline run.

Enum:"Succeeded""Failed""Cancelled""InProgress""Queued""Canceling"null
Example:"Succeeded"
messagestring or null

Additional details or any error messages related to the pipeline run. This field is empty if no message is available.

Default:""
Example:""
Response
{
  "createdOn": "2025-04-23T13:55:13.308326",
  "createdBy": "mman",
  "updatedOn": "2025-04-23T13:55:13.308326",
  "updatedBy": "mman",
  "id": "e774b4b6-204e-11f0-a62d-3e62ff39b87e",
  "pipelineId": "string",
  "parameters": {
    "brand_kit_id": "98689dd5-1684-48cb-a339-d9610dbd7986",
    "org_id": "org_ZiiCnzhCeHDpWJAU",
    "baseUrlDocAPI": "https://ai-documents-api-euw.sitecorecloud.io"
  },
  "runStart": "2025-06-18T12:46:12.718310",
  "runEnd": "2025-06-18T12:46:12.718310",
  "durationInMs": 3,
  "status": "Succeeded",
  "message": ""
}