orchestration

Create Optimize And Deploy Pipeline

Create an orchestrated pipeline: audit pages, optimize content, and deploy to AXP

post/orchestration/optimize-and-deploy/{brand_id}

Request

Base URL
https://api.scrunchai.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/scrunch/apis/scrunch-data-api/docs/orchestration/optimize-and-deploy/:brand_id/post.ts
A function with typed inputs. Its response is checked against the schema.

brand_idinteger required

urlsstring[] nullable

Simple list of URLs to audit (use this OR requests, not both)

optimizeboolean

Run content optimization after audit

deploy_axpboolean

Deploy optimized content to AXP (requires optimize=true and site_id)

stage_axpboolean

Audit + optimize + stage content without deploying live (requires optimize=true and site_id; mutually exclusive with deploy_axp)

site_idstring nullable

RegisteredSite ID for AXP staging/deployment (required if deploy_axp or stage_axp)

target_promptsstring[] nullable

Prompts for optimization (optional - if omitted, we infer from page content)

target_sourcesstring[] nullable

Source URLs for optimization (optional)

override_suggestionsboolean

Skip AI suggestions, use only provided prompts/sources

webhook_url_overridestring uri nullable

Webhook URL override for this pipeline (uses brand default if not set)

Successful Response

pipeline_idstring nullable

Pipeline ID for batched AXP deployment (only set if deploy_axp=true)

statusstring

Pipeline status

No recorded changes to this operation across all 3 revisions of this API.