Internal API

Website modifications

17 endpoints.

GET/api/v1/internal/businesses/{business_id}/website-mod/check-gate

Get Website Mod Check Gate

``{blocked, status, problems, message}``: whether the pending change's browser check holds it back (the inbox router's guard on a chat "yes").

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field Type Description

request_idrequired string

success true default true

datarequired object

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/businesses/{business_id}/website-mod/context

Get Website Mod Context

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`verify_repo`	query	`boolean`	default false
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/businesses/{business_id}/website-mod/pending-changes

Get Pending Website Mod Changes

List console-safe pending website-mod changes for a business (no GitHub PR fields).

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/businesses/{business_id}/website-mod/requirements/texts

Post Website Mod Requirement Texts

Return decoded requirement document text for router clarify / plan hydration.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonRequirementTextsRequest

Field	Type	Description
`file_ids`	`string[]`	max items 10 string[] fields

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/website-mod/agent-callback

Post Website Mod Agent Callback

Store agent job outcome for SOR plan polling (Redis, keyed by plan_request_id).

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonWebsiteModAgentCallbackRequest

Field	Type	Description
`plan_request_id`required	`string`
`website_id`required	`string \| string (uuid)`	string \| string (uuid) fields string string (uuid)
`status`required	`string`
`summary`	`string`	default ""
`agent_message`	`string`	default ""
`file_updates`	`object[]`	object[] fields
`primitives`	`object[]`	object[] fields
`error`	`string`	default ""
`cost_usd`	`number \| null`
`duration_s`	`number \| null`
`run_id`	`string`	default ""
`smoke`	`object \| null`
`confirmation`	`object \| null`
`denied_commands`	`string[]`	string[] fields
`stop_source`	`string`	default ""
`model`	`string`	default ""
`usage`	`object \| null`
`browser_check`	`object \| null`
`check_only`	`boolean`	default false
`interrupt`	`object \| null`
`notes_delivered`	`string[]`	string[] fields
`fetched_urls`	`object[]`	object[] fields
`notes_pending`	`string[]`	string[] fields

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/website-mod/agent-progress

Post Website Mod Agent Progress

Append a sanitized progress event for the live console activity feed.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonWebsiteModAgentProgressRequest

Field	Type	Description
`plan_request_id`required	`string`
`website_id`required	`string \| string (uuid)`	string \| string (uuid) fields string string (uuid)
`seq`required	`integer`
`ts`	`integer \| null`
`kind`required	`string`
`stage`	`string \| null`
`text`	`string \| null`
`tool`	`string \| null`
`label`	`string \| null`
`block`	`string \| null`
`status`	`string \| null`
`partial`	`boolean`	default false
`artifact`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/website-mod/check-artifacts

Post Website Mod Check Artifact

One browser-check screenshot from a session pod, while its run is going (or its "Check again" run is marked). The image is the raw request body.

Parameters

Name	In	Type	Description
`plan_request_id`required	query	`string`
`route`required	query	`string`
`viewport`required	query	`string`
`kind`	query	`string`	default "fold"
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/website-mod/deploy-reconcile

Post Website Mod Deploy Reconcile

Kairos HTTP callback: poll pending website-mod deploys and self-reschedule.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/cancel-pending

Post Cancel Pending Website Mod

Clear Redis pending-change + release repo lock after reject/cancel.

``tombstone_run``: the engine, giving up on a plan, knows the run is over. The run's cancelled tombstone is laid FIRST — it is what stops a sor plan handler still executing past the engine's hangup from registering a change nobody can publish (it answers the cancelled terminal at its late check instead; prod KS-2485) — then the usual scoped cleanup runs.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/deploy-status

Post Deploy Status

Poll GitHub Actions deploy.yml status for a pending website-mod production deploy.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/gate-status

Post Website Mod Gate Status

Read-mostly gate probe (Redis + open Keystone PRs + lock) after GH reconcile.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/merge-deploy

Post Merge Deploy

Merge an approved PR and best-effort trigger ``deploy.yml``.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/plan-and-open-pr

Post Plan And Open Pr

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonPlanAndOpenPrRequest

Field	Type	Description
`business_id`required	`string \| string (uuid)`	string \| string (uuid) fields string string (uuid)
`workflow_run_id`	`string`	default ""
`thread_id`	`string`	default ""
`extracted_data`	`object \| null`
`force_repo_map_refresh`	`boolean`	default false
`plan_modes`	`string[] \| null`	string[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/preview-status

Post Preview Status

Poll for the Cloudflare version preview URL of a website-mod PR branch.

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/reconcile-pending

Post Website Mod Reconcile Pending

Align Redis + repo_locks with open Keystone website-mod PRs (GitHub = SoT).

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/repo-lock/acquire

Post Acquire Repo Lock

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/website-mod/repo-lock/release

Post Release Repo Lock

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonobject

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.