Get Clarity Process

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.

GET /v2/clarity-v2/processes/{process_id}

Get Clarity Process

cURL

curl --request GET \
  --url https://api.duvo.ai/v2/clarity-v2/processes/{process_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "process": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": 0,
    "generation_error": "<string>",
    "generation_progress": {
      "steps": [
        {
          "key": "<string>",
          "label": "<string>",
          "order": 123,
          "count": 123
        }
      ]
    },
    "custom_prompt": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "current_process_versions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_current_process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sandbox_id": "<string>",
      "last_session_id": "<string>"
    }
  ],
  "transformation_proposal_versions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clarity_current_process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_transformation_proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sandbox_id": "<string>",
      "last_session_id": "<string>",
      "extra_capture_requests": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "step_id": "<string>",
          "capture_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "requested_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gap": "<string>",
          "suggested_prompt": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    }
  ],
  "captures": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "videoUrl": "<string>",
      "videoTranscript": "<string>",
      "transcript": [
        {
          "message": "<string>",
          "timestamp": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userName": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

process_id · string<uuid> · required

The clarity process id

Response

200

application/json

Default Response

process · object · required

Show child attributes

current_process_versions · object[] · required

All non-deleted current-process snapshots, newest first. Lightweight rows (no data) for the version-picker UI. Clients lazy-fetch the live (or selected) snapshot via the per-snapshot detail endpoint.

Show child attributes

transformation_proposal_versions · object[] · required

All non-deleted transformation-proposal snapshots, newest first. Lightweight rows (no data) for the version-picker UI.

Show child attributes

captures · object[] · required

All captures (videos, interviews, documents) attached to this process. Field names follow the legacy v1 capture wire format (camelCase) so existing capture consumers keep working unchanged.

Show child attributes