Skip to navigation
PlatformBrand Kits

API · BrandKit · Record the start of the brand’s background enrichment run

View as Markdown

Record the kit’s one background enrichment run before launching it. The record lives on the brand kit, so readiness reports enrichment: running and any other launcher (another conversation, a trigger, another workspace member) is refused with 409 while a run younger than two hours is recorded. A stale, failed or complete record is replaced and the new run is returned. Call this first, then launch the enrichment task with the same task_id; on 409, do not launch.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brand_idstringRequiredformat: "uuid"
Brand kit UUID

Request

This endpoint expects an object.
task_idstringRequired<=128 characters

Identifier of the run about to be launched; finishBrandEnrichment must quote it.

target_keyslist of stringsRequired

Canonical keys the run will fill (from readiness enrichment.missing).

Response

Run recorded
task_idstringOptional
statusenumOptional
Allowed values:
started_atdatetimeOptional
finished_atdatetime or nullOptional
target_keyslist of stringsOptional
summarystring or nullOptional

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error