Get Readiness

GET

/api/canvas/{deal_id}/readiness

curl --request GET \
  --url https://example.com/api/canvas/example/readiness \
  --header 'Authorization: Bearer <token>'

Get aggregate document readiness snapshot (cached, no LLM calls).

Combines cached quality scores, approval status, version history staleness, and section completeness into a single 0-100 score with letter grade and actionable detail. Response also includes a sections array (per-section detail) for the DocumentHealthBar UI.

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Responses

200

Successful Response

Media type application/json

ReadinessResponse

Aggregate document readiness response — emitted by GET /canvas/{deal_id}/readiness and POST .../readiness/refresh.

object

deal_id

required

Deal Id

string

overall_score

required

Overall Score

integer

grade

required

Grade

string

sections_scored

required

Sections Scored

integer

sections_total

required

Sections Total

integer

sections_approved

required

Sections Approved

integer

avg_section_quality

Any of:

number

number

null

null

weakest_sections

required

Weakest Sections

Array<object>

WeakSectionEntry

Weakest-section entry — keys match the dict shape emitted by readiness_service._compute_snapshot.

object

key

required

Key

string

label

required

Label

string

score

required

Score

integer

stale_sections

required

Stale Sections

Array<string>

missing_sections

required

Missing Sections

Array<string>

computed_at

required

Computed At

number

model_integrity_score

Any of:

number

number

null

null

model_integrity_detail

Any of:

object

object

key

additional properties

any

null

null

financial_completeness_score

Any of:

number

number

null

null

parsed_tabs_count

Any of:

integer

integer

null

null

quality_unavailable

Quality Unavailable

boolean

research_constrained_sections

Any of:

Array<string>

Array<string>

null

null

research_health_summary

Any of:

object

object

key

additional properties

any

null

null

quality_component

Any of:

number

number

null

null

completeness_component

Any of:

number

number

null

null

approval_component

Any of:

number

number

null

null

freshness_component

Any of:

number

number

null

null

dimensions

required

ReadinessDimensions

Per-dimension 0-100 sub-scores feeding the weighted overall_score.

quality is null when quality_unavailable; model_integrity is null when no Excel cross-tab data exists. Other components are always populated.

object

quality

Any of:

number

number

null

null

completeness

Any of:

number

number

null

null

approval

Any of:

number

number

null

null

freshness

Any of:

number

number

null

null

model_integrity

Any of:

number

number

null

null

sections

required

Sections

Array<object>

ReadinessSectionDetailResponse

Per-section readiness row consumed by DocumentHealthBar.

object

section_key

required

Section Key

string

display_name

required

Display Name

string

quality_score

required

Quality Score

integer

is_approved

required

Is Approved

boolean

is_stale

required

Is Stale

boolean

is_missing

required

Is Missing

boolean

top_issue

Any of:

string

string

null

null

key

additional properties

any

Example

{
  "quality_unavailable": false
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}