KOkobaltlabs
marketing-guideline-sets

Start Guideline Set Decomposition

Changed on

Read this set's primary documents and propose requirements from them.

Additional documents are persisted onto the set's own membership first (_add_members) — the reading and the set's configuration are one gesture from here, not two, since a document added only for this run would leave the next reading unable to reproduce what this one saw.

Writes PROPOSED requirements only: no analysis can reach one until a person approves it (GuidelineRequirementState.PROPOSED is excluded everywhere a library is resolved for judging), so running this against a set an analysis already reads changes nothing about what that analysis sees until someone acts on what comes back.

post/marketing/guideline-sets/{guideline_set_id}/decompositions

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/marketing/guideline-sets/{guideline_set_id}/decompositions
  • Auth
    none declared

Path parameters

guideline_set_idstring uuid required

Request body

auto_determine_supporting_filesboolean

Response

Successful Response

decomposition_idstring uuid required
status'queued' | 'running' | 'succeeded' | 'failed' required

Lifecycle of one decomposition run.

documents_queuedinteger required
documents_skippedinteger required
selecting_supporting_documentsboolean

Changes