v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-21149158448.6 KB
Diamond
custom-harnesses

Get Custom Harness

Get a single custom harness by ID with optional workflow status.

Returns the harness (business status: DRAFT/ACTIVE/ARCHIVED) enriched with workflow status (execution state: RUNNING/SUCCEEDED/FAILED) if a workflow exists.

Client interpretation:

  • harness.status=DRAFT + no workflow = Not started yet
  • harness.status=DRAFT + workflow.status=RUNNING = Generation in progress
  • harness.status=DRAFT + workflow.status=FAILED = Generation failed, can retry
  • harness.status=ACTIVE = Generation completed successfully

Requires agent:read permission.

get/v1/custom-harnesses/{harness_id}

Path parameters

harness_idstring uuid required

Query parameters

team_idstring uuid nullable

Team ID (required)

Team ID (required)

Response

Successful Response