Skip to content

Update Research Report

PATCH
/research-reports/{report_id}

Update a Research report’s markdown content and/or status.

Read-side counterpart already exists (GET /research-reports); this closes the “read but can’t update” gap for the Research bucket. On a content change it creates a DocumentVersion snapshot AND re-indexes the report to the RAG knowledge base — identical to the internal Studio editor, so search never goes stale relative to an API-driven edit.

Partial update: send markdown_content, status, or both. Returns 400 if neither is provided, 404 if the report does not exist in this org. A report already ‘completed’/‘approved’ can only move between those two states.

Authorizations

Parameters

Path Parameters

report_id
required

Research report ID (UUID)

string

Research report ID (UUID)

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Body for PATCH /research-reports/{report_id}.

Partial update: send only what you want to change. At least one of markdown_content / status must be present.

object
markdown_content
Any of:
string
status
Any of:
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string