Skip to navigation
PlatformBrand Kits

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

View as Markdown

Close the recorded enrichment run with its outcome. The enrichment agent calls this as its last step, quoting the task_id it was launched with; 409 when that id is not the recorded run (a replaced run reporting late), in which case there is nothing further to do.

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
statusenumRequired
Allowed values:
summarystringOptional<=4000 characters
One paragraph on what was written or why the run stopped.

Response

Run closed
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