ClarityV2

Manage Clarity v2 process snapshots, transformation proposals, and the extra-capture-request follow-up loop

get

List Clarity processes for the current team, most recently created first. Returns lightweight metadata (capture counts, contributors, status) suitable for building a picker; the per-process read model is available via GET /v1/clarity-v2/processes/:process_id. Both v1 (legacy) and v2 processes are returned; filter on version if you only care about one. Capped at 100 per page.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Query parameters
limitinteger · min: 1 · max: 100Optional

Number of processes per page (1-100, default 50)

Default: 50
offsetinteger · max: 9007199254740991Optional

Number of processes to skip (default 0)

Responses
200

Default Response

application/json
totalinteger · min: -9007199254740991 · max: 9007199254740991Required
limitinteger · min: -9007199254740991 · max: 9007199254740991Required
offsetinteger · min: -9007199254740991 · max: 9007199254740991Required
get
/v1/clarity-v2/processes
get

Get the v2 read model for a clarity process: the process row (with operational fields like generation_error, generation_progress, custom_prompt), its captures, and the lightweight version arrays for both snapshot tabs. The full payload of any specific snapshot is fetched lazily via the per-snapshot detail endpoints (GET .../current-process/:id and GET .../transformation-proposal/:id); this read model deliberately doesn't carry it so the response stays small.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
get
/v1/clarity-v2/processes/{process_id}
post

Trigger the generateCurrentProcess pipeline for a v2 clarity process. Returns 202 immediately and finalises the snapshot asynchronously via the cc-server webhook stream. Visible through GET /v1/clarity-v2/processes/:process_id once complete.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
post
/v1/clarity-v2/processes/{process_id}/current-process
post

Trigger a transformation-proposal pipeline for a v2 clarity process. With no body or current_process_id, runs the generate pipeline against the chosen current-process snapshot (latest by default). With regenerate_from: <previousProposalId>, runs the regenerate pipeline anchored to the prior proposal's current-process and the extra captures collected since. Returns 202 immediately and finalises asynchronously via the cc-server webhook stream.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Body
current_process_idstring · uuidOptional

ID of a clarity_current_process row to anchor the new proposal to. When supplied, runs the generate pipeline against that snapshot. Defaults to the latest snapshot for the process.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
regenerate_fromstring · uuidOptional

ID of a clarity_transformation_proposal row to refine. When supplied, runs the regenerate pipeline using that proposal's current-process snapshot as the anchor and the extra captures collected since.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
post
/v1/clarity-v2/processes/{process_id}/transformation-proposal
post

Stop an in-flight transformation-proposal generation. Reads the sandbox id from the process row, kills the sandbox, flips the process back to review, and clears the sandbox marker so any late webhook from the killed run is dropped as stale.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
successbooleanRequired
post
/v1/clarity-v2/processes/{process_id}/transformation-proposal/stop
post

Re-run postprocessing agents on an existing v2 clarity snapshot. Targets either the current-process snapshot or the transformation-proposal snapshot, identified by id in the body. Flips the process status to generating and returns 202 immediately; agents run asynchronously and flip the status back to review once they settle.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Body
or
Responses
post
/v1/clarity-v2/processes/{process_id}/postprocess
get

Fetch the full payload of a single current-process snapshot, including the BPMN data JSONB. Lazy-loaded by the picker when the user selects a specific version. v2 only.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
current_process_idstring · uuidRequired

The current-process snapshot id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
get
/v1/clarity-v2/processes/{process_id}/current-process/{current_process_id}
delete

Soft-delete a current-process snapshot for a clarity v2 process. v2 only — returns 403 for v1 processes.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
current_process_idstring · uuidRequired

The current-process snapshot id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
successbooleanRequired
delete
/v1/clarity-v2/processes/{process_id}/current-process/{current_process_id}
get

Fetch the full payload of a single transformation-proposal snapshot, including the BPMN data JSONB. Lazy-loaded by the picker when the user selects a specific version. v2 only.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
transformation_proposal_idstring · uuidRequired

The transformation-proposal snapshot id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
get
/v1/clarity-v2/processes/{process_id}/transformation-proposal/{transformation_proposal_id}
delete

Soft-delete a transformation proposal for a clarity v2 process. v2 only — returns 403 for v1 processes.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
transformation_proposal_idstring · uuidRequired

The transformation proposal id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
successbooleanRequired
delete
/v1/clarity-v2/processes/{process_id}/transformation-proposal/{transformation_proposal_id}
post

Hand the latest transformation proposal for a v2 clarity process off to the workflow-builder pipeline. Returns 202 with the new run id; the LLM run completes asynchronously.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
post
/v1/clarity-v2/processes/{process_id}/automation
get

List active extra-capture requests for a given transformation proposal of a Clarity v2 process. The caller is expected to know the proposal id from the V2 read model and skip the call when no proposal exists yet.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
transformation_proposal_idstring · uuidRequired

The transformation proposal id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Query parameters
limitinteger · min: 1 · max: 100Optional

Number of results per page (1-100, default 20)

Default: 20
offsetinteger · max: 9007199254740991Optional

Number of results to skip (default 0)

Responses
200

Default Response

application/json
totalinteger · min: -9007199254740991 · max: 9007199254740991Required

Total matching rows across all pages

limitinteger · min: -9007199254740991 · max: 9007199254740991Required

Page size that was applied

offsetinteger · min: -9007199254740991 · max: 9007199254740991Required

Offset that was applied

get
/v1/clarity-v2/processes/{process_id}/transformation-proposals/{transformation_proposal_id}/extra-capture-requests
patch

Assign (or unassign, with user_id: null) a team member to fulfil an extra-capture request. Restricted to admins and managers.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
transformation_proposal_idstring · uuidRequired

The transformation proposal id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
request_idstring · uuidRequired

The extra-capture-request id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Body
user_idstring · uuid · nullableRequired

Team member to assign, or null to unassign

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
patch
/v1/clarity-v2/processes/{process_id}/transformation-proposals/{transformation_proposal_id}/extra-capture-requests/{request_id}/assign
post

Promote a historic current-process snapshot to live. Demotes the previously live row to historic in the same transaction. No-op if the target is already live. v2 only.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
current_process_idstring · uuidRequired

The current-process snapshot id to promote

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
post
/v1/clarity-v2/processes/{process_id}/current-process/{current_process_id}/promote
post

Promote a historic transformation-proposal snapshot to live. Demotes the previously live row to historic in the same transaction. No-op if the target is already live. Live uniqueness is scoped to process_id (not the current-process anchor). v2 only.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
process_idstring · uuidRequired

The clarity process id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
transformation_proposal_idstring · uuidRequired

The transformation-proposal snapshot id to promote

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
post
/v1/clarity-v2/processes/{process_id}/transformation-proposal/{transformation_proposal_id}/promote

Last updated