Skip to content
em sa em sa

Refresh Readiness

POST
/api/canvas/{deal_id}/readiness/refresh
 
curl --request POST \
  --url https://example.com/api/canvas/example/readiness/refresh \
  --header 'Authorization: Bearer <token>'

Force-recompute document readiness (bypasses cache).

Requires Editor role. Broadcasts READINESS_UPDATED via WebSocket.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “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
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
model_integrity_detail
Any of:
object
key
additional properties
any
financial_completeness_score
Any of:
number
parsed_tabs_count
Any of:
integer
quality_unavailable
Quality Unavailable
boolean
research_constrained_sections
Any of:
Array<string>
research_health_summary
Any of:
object
key
additional properties
any
quality_component
Any of:
number
completeness_component
Any of:
number
approval_component
Any of:
number
freshness_component
Any of:
number
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
completeness
Any of:
number
approval
Any of:
number
freshness
Any of:
number
model_integrity
Any of:
number
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
key
additional properties
any
Example 
{
  "quality_unavailable": false
}

422

Section titled “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": {}
    }
  ]
}