Skip to main content
GET
Get an edit record
Retrieve the current state and result of a single DeepResearch edit. Poll this endpoint after receiving 202 from Create edit until status reaches a terminal state.

Edit statuses

A report edit applied to a task that also has deliverable files includes the warning deliverables_stale, noting that the deliverable files were not updated to match. Only the task owner can read edit records (403 for shared or public viewers). See Edit a finished report.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at platform.valyu.ai.

Path Parameters

id
string
required

DeepResearch task ID.

edit_id
string
required

Edit ID returned by POST /v1/deepresearch/tasks/{id}/edit.

Response

Edit record.

Full record of a DeepResearch edit.

edit_id
string
required

Unique identifier for this edit.

Example:

"ed_01j9x4k2m8n7p3q5r6s8t0v2w4"

deepresearch_id
string
required

DeepResearch task ID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status
enum<string>
required

Lifecycle status of the edit.

Available options:
running,
applied,
declined,
failed
target
object
required

What to edit: the written report ({"kind": "report"}, default) or a specific deliverable file ({"kind": "deliverable", "deliverable_id": "f_01"}).

base_version
integer
required

Version number the edit was applied against.

Required range: x >= 1
created_at
string<date-time>
required

ISO 8601 timestamp when the edit was created.

version
integer | null

New version number created when status is applied.

Required range: x >= 1
focus
object | null

Focus supplied in the edit request, if any.

retry_after_seconds
number | null

Suggested polling delay in seconds while status is running.

summary
string | null

Short summary of the result.

changes
object[]

The changed blocks of lines, in order, at most 50. Each block gives the 1-based line in the base version's output (the version the edit started from) where it begins, and the whole lines removed and added, at most 40 of each. stats counts the full edit even when this list is cut short.

Maximum array length: 50
unapplied
(string | object)[]

Parts of the instruction that could not be applied.

stats
object | null

Metrics for the edit (such as replacement count and characters changed).

warnings
object[]

Warnings produced by the edit, such as deliverables_stale when a report edit runs on a task with deliverable files.

decline
object | null

Present when status is declined.

error
object | null

Present when status is failed.

pdf_url
string<uri> | null

URL to the re-rendered PDF for the new version when the task has a PDF.