curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/edit \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "instruction": "Cut the executive summary to 3 bullets and add the Q3 revenue figure with its citation.", "focus": { "section": "Executive Summary", "scope": "strict" }, "base_version": 1, "citations": "stable", "wait_seconds": 15}'
{ "edit_id": "ed_01j9x4k2m8n7p3q5r6s8t0v2w4", "deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "applied", "target": { "kind": "report" }, "base_version": 1, "version": 2, "focus": { "section": "Executive Summary", "scope": "strict" }, "created_at": "2026-11-19T14:20:00.000Z", "summary": "Condensed the Executive Summary to 3 bullets and added the Q3 revenue figure with citation [14].", "changes": [ { "section": "Executive Summary", "description": "Replaced the 6-bullet summary with 3 bullets and added Q3 revenue cited to [14]." } ], "unapplied": [], "stats": { "replacements": 1, "chars_changed": 412, "citations_added": 1 }, "warnings": [], "pdf_url": "https://api.valyu.ai/v1/deepresearch/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/assets/report.pdf?version=2"}
Create Edit
Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks//edit.
POST
/
v1
/
deepresearch
/
tasks
/
{id}
/
edit
curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/edit \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "instruction": "Cut the executive summary to 3 bullets and add the Q3 revenue figure with its citation.", "focus": { "section": "Executive Summary", "scope": "strict" }, "base_version": 1, "citations": "stable", "wait_seconds": 15}'
{ "edit_id": "ed_01j9x4k2m8n7p3q5r6s8t0v2w4", "deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "applied", "target": { "kind": "report" }, "base_version": 1, "version": 2, "focus": { "section": "Executive Summary", "scope": "strict" }, "created_at": "2026-11-19T14:20:00.000Z", "summary": "Condensed the Executive Summary to 3 bullets and added the Q3 revenue figure with citation [14].", "changes": [ { "section": "Executive Summary", "description": "Replaced the 6-bullet summary with 3 bullets and added Q3 revenue cited to [14]." } ], "unapplied": [], "stats": { "replacements": 1, "chars_changed": 412, "citations_added": 1 }, "warnings": [], "pdf_url": "https://api.valyu.ai/v1/deepresearch/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/assets/report.pdf?version=2"}
Apply a small, targeted natural-language edit to a completed DeepResearch markdown report or one of its generated deliverable files. Edits make exact replacements so untouched text stays byte-for-byte identical, and new citations only reference sources the task already gathered.Set wait_seconds (0 to 20) to wait inline for completion. If the edit finishes within that window, the endpoint returns 200 with the full edit record. Otherwise it returns 202 with edit_id and retry_after_seconds; poll Get edit until status is applied, declined, or failed. Pass an Idempotency-Key header so retries after a timeout return the same edit.
Rules
Owner only: Only the task owner can submit edits. Shared and public viewers receive 403.
Completed markdown reports: The task must be completed and must produce a markdown report (not a structured JSON-schema output). Check editable in Get status.
One edit at a time: Only one edit or restore runs at a time per task. Concurrent requests return 409 with edit.in_progress.
Strict request body: Unknown fields are rejected with 400edit.invalid_request.
Optimistic concurrency: Send base_version to guard against concurrent edits; if the head has moved on, the endpoint returns 409 with edit.revision_conflict.
Error and decline codes
Request errors return a 4xx status before an edit runs. Content-level refusals finish with 200 and status: "declined" with decline: { code, message, suggestion }.
HTTP / Status
Code
Meaning
400
edit.invalid_request
Invalid field, unknown JSON field, or mismatched offset pair
403
-
Caller is not the task owner
404
-
Task not found, or editing is not enabled
409
edit.task_not_completed
Task is not in completed state
409
edit.in_progress
Another edit or restore is running on this task
409
edit.revision_conflict
base_version does not match the current head
409
edit.unsupported_task
Task output is not an editable markdown report
422
focus.not_found
Focused passage or section could not be found (nothing ran)
422
focus.ambiguous
Focus matched multiple locations; body includes candidates[] (nothing ran)
429
edit.busy
Temporary capacity limit; retry later
declined
edit.rewrite_requested
Change exceeds the edit cap; start a new task instead
declined
edit.out_of_evidence
Requires information the task’s research did not gather
declined
edit.contradictory
Instruction is self-contradictory or conflicts with constraints
declined
edit.unsafe_instruction
Instruction cannot be safely carried out
declined
edit.not_applicable
Instruction does not apply to the target or focus
declined
edit.no_change
Target already matches the instruction
See Edit a finished report for a full walkthrough of report and deliverable edits, focus matching, and agent workflows.
Optional idempotency key. Replaying the request with the same key returns the same edit instead of starting a duplicate.
Path Parameters
id
string
required
DeepResearch task ID.
Body
application/json
Request body for editing a completed DeepResearch report or deliverable. Unknown fields are rejected with 400edit.invalid_request.
instruction
string
required
Plain-English description of the change to make.
Required string length: 1 - 4000
Example:
"Cut the executive summary to 3 bullets and add the Q3 revenue figure with its citation."
target
object
What to edit: the written report ({"kind": "report"}, default) or a specific deliverable file ({"kind": "deliverable", "deliverable_id": "f_01"}).
Option 1
Option 2
Show child attributes
focus
object
Optional pointer to a passage or section in the report.
Show child attributes
base_version
integer
Version number you are editing. If the task head has moved on, the endpoint returns 409edit.revision_conflict.
Required range: x >= 1
Example:
1
citations
enum<string>
default:stable
stable (default) keeps existing citation numbers, appends new citations after the highest used, and retires dropped ones. compact renumbers citations by first use.
Available options:
stable,
compact
wait_seconds
number
Seconds to wait inline for the edit to finish (0 to 20). Returns 200 with the full edit record if finished in time, otherwise 202.
Required range: 0 <= x <= 20
Example:
15
Response
Edit finished within wait_seconds (or replayed via Idempotency-Key after finishing). Check status (applied, declined, or failed).
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"}).
Option 1
Option 2
Show child attributes
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.
Show child attributes
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
Show child attributes
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.
Show child attributes
decline
object | null
Present when status is declined.
Show child attributes
error
object | null
Present when status is failed.
Show child attributes
pdf_url
string<uri> | null
URL to the re-rendered PDF for the new version when the task has a PDF.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Valyu","colors":{"primary":"#5E3454","light":"#C7E04A","dark":"#5E3454"},"logo":{"light":"https://mintcdn.com/valyu/XSNGAn-w-x47KJwH/logo/valyu-wordmark-light.svg?fit=max\u0026auto=format\u0026n=XSNGAn-w-x47KJwH\u0026q=85\u0026s=334dd47b5c8dd1f11877b78e19848e24","dark":"https://mintcdn.com/valyu/XSNGAn-w-x47KJwH/logo/valyu-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=XSNGAn-w-x47KJwH\u0026q=85\u0026s=0c6b3fd58f6d88e020a0ed506dfc7752"},"favicon":"https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/favicon.ico?fit=max\u0026auto=format\u0026n=ji-tdRNtRRe7QxMv\u0026q=85\u0026s=fef49c51724555d91437907a324be0a3","appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#141118"}},"navbar":{"links":[{"icon":"wave-pulse","href":"https://status.valyu.ai","label":"API status"},{"href":"/integrations/onboard-agents","label":"Connect your agents"}],"primary":{"type":"button","label":"Get an API key","href":"https://platform.valyu.ai/user/account/apikeys"}},"footer":{"socials":{"discord":"https://discord.gg/umtmSsppRY","x":"https://x.com/ValyuOfficial","github":"https://github.com/valyuAI","linkedin":"https://linkedin.com/company/valyu-ai"},"links":[{"header":"Product","items":[{"label":"Platform","href":"https://platform.valyu.ai"},{"label":"Data sources","href":"https://platform.valyu.ai/data-sources"},{"label":"Pricing","href":"https://docs.valyu.ai/pricing"}]},{"header":"Developers","items":[{"label":"API status","href":"https://status.valyu.ai"},{"label":"OpenAPI spec","href":"https://docs.valyu.ai/api-reference/openapi.json"},{"label":"Cookbook","href":"https://github.com/valyuAI/cookbook"},{"label":"All guides","href":"/guides"}]},{"header":"Company","items":[{"label":"valyu.ai","href":"https://www.valyu.ai"},{"label":"Blog","href":"https://valyu.ai/blog"},{"label":"Contact","href":"mailto:contact@valyu.ai"}]}]},"seo":{"metatags":{"viewport":"width=device-width, initial-scale=1.0","description":"Search API and agents for knowledge work.","og:type":"website","og:site_name":"Valyu","twitter:card":"summary_large_image","twitter:site":"@ValyuOfficial","twitter:creator":"@ValyuOfficial","robots":"index, follow","googlebot":"index, follow","author":"Valyu"},"organization":{"name":"Valyu","url":"https://www.valyu.ai","sameAs":["https://x.com/ValyuOfficial","https://linkedin.com/company/valyu-ai","https://github.com/valyuAI"]},"indexing":"all"},"fonts":{"family":"Schibsted Grotesk","weight":400},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"posthog":{"apiKey":"phc_5WQIKDC13UTOCbh5VHAxwaDNzGL8wdmHfXON0ErVDxM","apiHost":"https://eu.i.posthog.com","sessionRecording":true}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode",{"title":"Open in Valyu","description":"Run this page as a query in Valyu DeepResearch","icon":"magnifying-glass","href":{"base":"https://platform.valyu.ai/playground/deepresearch","query":[{"key":"q","value":"$page"}]}},{"title":"Join our Discord","description":"Get help and discuss with the Valyu community","icon":"discord","href":"https://discord.gg/umtmSsppRY"}],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"valyu","hasAudioNarration":false,"actualSubdomain":"valyu","customDomains":["docs.valyu.ai"],"gitSource":{"type":"github","owner":"valyuai","repo":"valyu-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6aff7220b9d4edca8d9b3b11","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Documentation","count":89},{"language":"default","tag":"Build and connect","count":38},{"language":"default","tag":"API Reference","count":37},{"language":"default","tag":"DeepResearch","count":24},{"language":"default","tag":"Integrations","count":18},{"language":"default","tag":"SDKs","count":18},{"language":"default","tag":"APIs","count":16},{"language":"default","tag":"Start here","count":12},{"language":"default","tag":"Sciences workflows","count":10},{"language":"default","tag":"Finance workflows","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gW8tenXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gf8tenXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gY8tenXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gU8tenXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gV8tenXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gb8tc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gW8tenXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gf8tenXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gY8tenXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gU8tenXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gV8tenXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Source Serif 4';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/sourceserif4/v15/vEFI2_tTDB4M7-auWDN0ahZJW1gb8tc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Spline Sans Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/splinesansmono/v13/R70BjzAei_CDNLfgZxrW6wrZOF2WX5yZmF2a.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Spline Sans Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/splinesansmono/v13/R70BjzAei_CDNLfgZxrW6wrZOF2WX5KZmA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Spline Sans Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/splinesansmono/v13/R70BjzAei_CDNLfgZxrW6wrZOF2WX5yZmF2a.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Spline Sans Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/splinesansmono/v13/R70BjzAei_CDNLfgZxrW6wrZOF2WX5KZmA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--vx-ink: #17141A;--vx-body: #54525C;--vx-muted: #8C8A93;--vx-line: #E7E5EA;--vx-surface: #FBFAFB;--vx-wash: #F4F1F5;--vx-plum: #5E3454;--vx-plum-soft: #7D4A6F;--vx-lilac: #CBB1C4;--vx-citron: #C7E04A;--vx-citron-ink: #2C3400;--vx-display: \"Helvetica Now Display\", \"Helvetica Neue\", Helvetica, \"Schibsted Grotesk\", Arial, sans-serif;--vx-serif: \"Source Serif 4\", Georgia, serif;--vx-mono: \"Spline Sans Mono\", ui-monospace, SFMono-Regular, Menlo, monospace}.dark{--vx-ink: #F3F0F5;--vx-body: #B9B4BF;--vx-muted: #8E8995;--vx-line: #2D2832;--vx-surface: #1B171F;--vx-wash: #1E1A22;--vx-plum: #CBB1C4;--vx-plum-soft: #E2D2DE;--vx-lilac: #6E5468}::selection{background:var(--vx-citron);color:var(--vx-citron-ink)}#page-title,#content-area :is(h1,h2,h3){font-family:var(--vx-display);font-weight:500;letter-spacing:-0.015em;color:var(--vx-ink)}#page-title{font-size:clamp(2rem, 3.4vw, 2.6rem);line-height:1.12;letter-spacing:-0.022em}#content-area h2{letter-spacing:-0.012em}#header .breadcrumb-item,.sidebar-group-header,.vx-label{font-family:var(--vx-mono);font-size:0.72rem!important;font-weight:400;letter-spacing:0.02em;text-transform:none}.sidebar-group-header{color:var(--vx-muted)!important}#content-area code:not(pre code){font-size:0.86em}.nav-tabs-item .bg-primary,.nav-tabs-item .dark\\:bg-primary-light{background:var(--vx-citron)!important}.nav-tabs-item:hover>[class*=\"group-hover\"]{background:var(--vx-plum-soft)!important}.callout,[class*=\"rounded-2xl\"]:not([class*=\"navbar-primary\"]):not([class*=\"pill\"]),[class*=\"rounded-xl\"]:not([class*=\"navbar-primary\"]):not([class*=\"pill\"]),[class*=\"rounded-lg\"]:not([class*=\"navbar-primary\"]):not([class*=\"pill\"]),[class*=\"rounded-md\"],[class*=\"rounded-sm\"],.nav-tabs-item,input[type=\"text\"],button:not([class*=\"pill\"]):not([class*=\"rounded-full\"]),pre,code{border-radius:0!important}[class*=\"navbar-primary\"] a,[class*=\"navbar-primary\"] button{border-radius:0!important}a[class*=\"rounded-full\"],button[class*=\"rounded-full\"]{border-radius:9999px!important}img.nav-logo{height:17px!important}#sidebar{border-right:1px solid var(--vx-line)}#sidebar-content{padding-right:1rem}#sidebar a[aria-current=\"page\"]{box-shadow:inset 2px 0 var(--vx-citron)}#header{position:relative;padding-bottom:1.25rem;border-bottom:1px solid var(--vx-line)}#header::after{content:\"\";position:absolute;bottom:-1px;left:0;width:40px;height:2px;background:var(--vx-citron)}#content-area .card{border-color:var(--vx-line);transition:border-color .15s ease, background-color .15s ease}#content-area .card:hover{border-color:var(--vx-plum-soft);background:var(--vx-surface)}#content-area table th{font-family:var(--vx-mono);font-size:0.72rem;font-weight:500;letter-spacing:0.02em;color:var(--vx-muted)}.vx-panel{position:relative;overflow:hidden;margin:1.75rem 0 2rem;padding:1.5rem;border:1px solid var(--vx-line);background:radial-gradient(120% 90% at 0% 0%, rgba(203, 177, 196, 0.28), transparent 60%),\n radial-gradient(90% 80% at 100% 100%, rgba(199, 224, 74, 0.2), transparent 62%),\n var(--vx-surface)}.dark .vx-panel{background:radial-gradient(120% 90% at 0% 0%, rgba(126, 84, 115, 0.22), transparent 60%),\n radial-gradient(90% 80% at 100% 100%, rgba(199, 224, 74, 0.07), transparent 62%),\n var(--vx-surface)}.vx-query{display:flex;align-items:center;gap:0.75rem;padding:0.85rem 1rem;border:1px solid var(--vx-line);background:rgba(255, 255, 255, 0.72);font-family:var(--vx-serif);font-size:1.05rem;color:var(--vx-ink)}.dark .vx-query{background:rgba(20, 17, 24, 0.6)}.vx-query .vx-ico{flex:0 0 18px;width:18px;height:18px;color:var(--vx-muted)}.vx-flow{display:grid;grid-template-columns:minmax(0, 1fr) 44px 112px 44px minmax(0, 1.08fr);height:288px;margin-top:1.25rem}.vx-stack{display:grid;gap:8px;min-width:0}.vx-sources{grid-template-rows:18px repeat(4, minmax(0, 1fr))}.vx-outputs{grid-template-rows:repeat(2, minmax(0, 1fr));gap:12px}.vx-stack>.vx-label{align-self:end;line-height:1;color:var(--vx-muted)}.vx-source{display:flex;min-width:0;align-items:center;gap:0.7rem;padding:0.6rem 0.75rem;border:1px solid var(--vx-line);background:#fff}.dark .vx-source,.dark .vx-output{background:#17141B}.vx-source .vx-ico{flex:0 0 18px;width:18px;height:18px;color:var(--vx-plum)}.vx-source b{display:block;font-size:0.84rem;font-weight:500;line-height:1.3;color:var(--vx-ink)}.vx-source div span{display:block;font-family:var(--vx-mono);font-size:0.66rem;line-height:1.4;color:var(--vx-muted)}.vx-wires{position:relative;display:block;width:100%;height:100%}.vx-wires::before,.vx-wires::after{content:\"\";position:absolute;inset:0}.vx-wires::before{background-color:var(--vx-lilac);-webkit-mask:var(--vx-wire-base) 0 0 / 100% 100% no-repeat;mask:var(--vx-wire-base) 0 0 / 100% 100% no-repeat}.vx-wires::after{background:var(--vx-wire-live) 0 0 / 100% 100% no-repeat}.vx-node{position:relative;display:flex;flex-direction:column;align-items:center;justify-content:center;align-self:center;gap:0.55rem;width:112px;height:112px;background:#17141A;color:#fff;box-shadow:0 18px 40px -22px rgba(23, 20, 26, 0.55)}.vx-node::after{content:\"\";position:absolute;top:10px;right:10px;width:5px;height:5px;background:var(--vx-citron)}.vx-node .vx-ico{width:34px;height:34px}.vx-node span:not(.vx-ico){font-family:var(--vx-serif);font-size:1.15rem;line-height:1}.dark .vx-node{background:#000;outline:1px solid var(--vx-line)}.vx-output{display:flex;flex-direction:column;justify-content:center;min-width:0;padding:1rem 1.1rem;border:1px solid var(--vx-line);background:#fff;color:inherit;text-decoration:none!important;border-bottom-width:1px!important;border-bottom-color:var(--vx-line)!important;transition:border-color .15s ease}.vx-output:hover{border-color:var(--vx-plum-soft)!important}.vx-output .vx-label{color:var(--vx-muted)}.vx-output b{display:block;margin:0.3rem 0 0.25rem;font-family:var(--vx-serif);font-size:1.35rem;font-weight:400;line-height:1.15;color:var(--vx-plum)}.vx-output p{margin:0;font-size:0.86rem;line-height:1.5;color:var(--vx-body)}.prose td{font-variant-numeric:normal}.vx-cr{white-space:nowrap}.vx-cr::before{content:\"\";display:inline-block;width:1em;height:1em;margin-right:0.3em;vertical-align:-0.15em;background-color:var(--vx-plum);-webkit-mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 256 256'%3E%3Cpath d='M240,132c0,19.88-35.82,36-80,36-19.6,0-37.56-3.17-51.47-8.44h0C146.76,156.85,176,142,176,124V96.72h0C212.52,100.06,240,114.58,240,132ZM176,84c0-19.88-35.82-36-80-36S16,64.12,16,84s35.82,36,80,36S176,103.88,176,84Z' opacity='0.2'/%3E%3Cpath d='M184,89.57V84c0-25.08-37.83-44-88-44S8,58.92,8,84v40c0,20.89,26.25,37.49,64,42.46V172c0,25.08,37.83,44,88,44s88-18.92,88-44V132C248,111.3,222.58,94.68,184,89.57ZM232,132c0,13.22-30.79,28-72,28-3.73,0-7.43-.13-11.08-.37C170.49,151.77,184,139,184,124V105.74C213.87,110.19,232,122.27,232,132ZM72,150.25V126.46A183.74,183.74,0,0,0,96,128a183.74,183.74,0,0,0,24-1.54v23.79A163,163,0,0,1,96,152,163,163,0,0,1,72,150.25Zm96-40.32V124c0,8.39-12.41,17.4-32,22.87V123.5C148.91,120.37,159.84,115.71,168,109.93ZM96,56c41.21,0,72,14.78,72,28s-30.79,28-72,28S24,97.22,24,84,54.79,56,96,56ZM24,124V109.93c8.16,5.78,19.09,10.44,32,13.57v23.37C36.41,141.4,24,132.39,24,124Zm64,48v-4.17c2.63.1,5.29.17,8,.17,3.88,0,7.67-.13,11.39-.35A121.92,121.92,0,0,0,120,171.41v23.46C100.41,189.4,88,180.39,88,172Zm48,26.25V174.4a179.48,179.48,0,0,0,24,1.6,183.74,183.74,0,0,0,24-1.54v23.79a165.45,165.45,0,0,1-48,0Zm64-3.38V171.5c12.91-3.13,23.84-7.79,32-13.57V172C232,180.39,219.59,189.4,200,194.87Z'/%3E%3C/svg%3E\") center / contain no-repeat;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 256 256'%3E%3Cpath d='M240,132c0,19.88-35.82,36-80,36-19.6,0-37.56-3.17-51.47-8.44h0C146.76,156.85,176,142,176,124V96.72h0C212.52,100.06,240,114.58,240,132ZM176,84c0-19.88-35.82-36-80-36S16,64.12,16,84s35.82,36,80,36S176,103.88,176,84Z' opacity='0.2'/%3E%3Cpath d='M184,89.57V84c0-25.08-37.83-44-88-44S8,58.92,8,84v40c0,20.89,26.25,37.49,64,42.46V172c0,25.08,37.83,44,88,44s88-18.92,88-44V132C248,111.3,222.58,94.68,184,89.57ZM232,132c0,13.22-30.79,28-72,28-3.73,0-7.43-.13-11.08-.37C170.49,151.77,184,139,184,124V105.74C213.87,110.19,232,122.27,232,132ZM72,150.25V126.46A183.74,183.74,0,0,0,96,128a183.74,183.74,0,0,0,24-1.54v23.79A163,163,0,0,1,96,152,163,163,0,0,1,72,150.25Zm96-40.32V124c0,8.39-12.41,17.4-32,22.87V123.5C148.91,120.37,159.84,115.71,168,109.93ZM96,56c41.21,0,72,14.78,72,28s-30.79,28-72,28S24,97.22,24,84,54.79,56,96,56ZM24,124V109.93c8.16,5.78,19.09,10.44,32,13.57v23.37C36.41,141.4,24,132.39,24,124Zm64,48v-4.17c2.63.1,5.29.17,8,.17,3.88,0,7.67-.13,11.39-.35A121.92,121.92,0,0,0,120,171.41v23.46C100.41,189.4,88,180.39,88,172Zm48,26.25V174.4a179.48,179.48,0,0,0,24,1.6,183.74,183.74,0,0,0,24-1.54v23.79a165.45,165.45,0,0,1-48,0Zm64-3.38V171.5c12.91-3.13,23.84-7.79,32-13.57V172C232,180.39,219.59,189.4,200,194.87Z'/%3E%3C/svg%3E\") center / contain no-repeat}.vx-stat-row{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1px;background:var(--vx-line);border:1px solid var(--vx-line);margin:1.5rem 0 2rem}.vx-stat{padding:1rem 1.1rem;background:#fff}.dark .vx-stat{background:#141118}.vx-stat .vx-label{display:block;color:var(--vx-muted)}.vx-stat b{display:block;margin-top:0.35rem;font-family:var(--vx-display);font-size:1.6rem;font-weight:500;letter-spacing:-0.02em;line-height:1.1;color:var(--vx-ink);font-variant-numeric:tabular-nums}.vx-stat b.vx-cr::before{width:0.8em;height:0.8em;margin-right:0.2em;vertical-align:-0.06em}.vx-stat span:not(.vx-label){display:block;margin-top:0.3rem;font-size:0.8rem;color:var(--vx-body)}.vx-mark{background:var(--vx-citron);color:var(--vx-citron-ink);padding:0 0.12em;box-decoration-break:clone;-webkit-box-decoration-break:clone}.vx-plans{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1px;background:var(--vx-line);border:1px solid var(--vx-line);margin:1.5rem 0 1rem}.vx-plan{position:relative;display:flex;flex-direction:column;padding:1.25rem 1.35rem;background:#fff}.dark .vx-plan{background:#141118}.vx-plan .vx-label{color:var(--vx-muted)}.vx-plan .vx-plan-name{margin:0.45rem 0 0;font-family:var(--vx-serif);font-size:1.3rem;line-height:1.2;color:var(--vx-plum)}.vx-plan .vx-price{margin:0.85rem 0 0.15rem;font-family:var(--vx-display);font-size:2rem;font-weight:500;letter-spacing:-0.025em;line-height:1;color:var(--vx-ink);font-variant-numeric:tabular-nums}.vx-plan .vx-price-unit{font-family:inherit;font-size:0.8rem;font-weight:400;letter-spacing:0;color:var(--vx-muted)}.vx-plan .vx-includes{margin:0.5rem 0 0.9rem;font-size:0.86rem;color:var(--vx-body)}.vx-plan .vx-includes b{color:var(--vx-ink);font-weight:500}.vx-plan ul{margin:auto 0 0;padding:0.85rem 0 0;border-top:1px solid var(--vx-line);list-style:none}.vx-plan li{position:relative;margin:0 0 0.35rem;padding-left:1rem;font-size:0.8rem;line-height:1.45;color:var(--vx-body)}.vx-plan li::before{content:\"\";position:absolute;left:0;top:0.5em;width:5px;height:5px;background:var(--vx-lilac)}.vx-plans .vx-plan-featured{background:var(--vx-surface);box-shadow:inset 0 2px 0 var(--vx-citron)}.vx-badge{display:inline-block;margin-left:0.4rem;padding:0.05rem 0.35rem;background:var(--vx-citron);color:var(--vx-citron-ink);font-family:var(--vx-mono);font-size:0.62rem;letter-spacing:0.02em;vertical-align:0.15em}.vx-wf-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1px;background:var(--vx-line);border:1px solid var(--vx-line);margin:1.25rem 0 2.25rem}.vx-wf{display:flex;flex-direction:column;padding:1.1rem 1.25rem 1.15rem;background:#fff;text-decoration:none;transition:background-color .15s ease}.dark .vx-wf{background:#141118}.vx-wf:hover{background:var(--vx-surface)}.vx-wf:last-child:nth-child(odd){grid-column:1 / -1}.vx-wf .vx-label{color:var(--vx-muted)}.vx-wf b{margin-top:0.4rem;font-family:var(--vx-serif);font-size:1.15rem;font-weight:400;line-height:1.25;color:var(--vx-plum)}.vx-wf b::after{content:\"→\";display:inline-block;margin-left:0.35em;font-family:var(--vx-display);font-size:0.9em;transition:transform .15s ease}.vx-wf:hover b::after{transform:translateX(3px)}.vx-wf-desc{margin-top:0.35rem;font-size:0.84rem;line-height:1.5;color:var(--vx-body)}.vx-wf-ex{margin-top:auto;padding-top:0.8rem;font-family:var(--vx-mono);font-size:0.68rem;letter-spacing:0.01em;color:var(--vx-muted)}.vx-wf-ex:not(.vx-wf-meta)::before{content:\"e.g. \"}.vx-reports{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1px;background:var(--vx-line);border:1px solid var(--vx-line);margin:1.25rem 0 2.25rem}.vx-report{display:flex;flex-direction:column;padding:1.15rem 1.25rem 1.1rem;background:#fff}.dark .vx-report{background:#141118}.vx-report:last-child:nth-child(odd){grid-column:1 / -1}.vx-report .vx-label{color:var(--vx-muted)}.vx-report h3{margin:0.4rem 0 0!important;font-family:var(--vx-serif)!important;font-size:1.15rem!important;font-weight:400!important;letter-spacing:0!important;line-height:1.25;color:var(--vx-plum)!important}.vx-report p{margin:0.4rem 0 0;font-size:0.84rem;line-height:1.5;color:var(--vx-body)}.vx-report-meta{display:flex;flex-wrap:wrap;gap:0.35rem;margin-top:0.75rem}.vx-report-meta span{padding:0.1rem 0.4rem;border:1px solid var(--vx-line);font-family:var(--vx-mono);font-size:0.66rem;color:var(--vx-body)}.vx-report-meta .vx-mode{background:var(--vx-citron);border-color:var(--vx-citron);color:var(--vx-citron-ink)}.vx-report-links{display:flex;flex-wrap:wrap;gap:0.9rem;margin-top:auto;padding-top:0.9rem;font-size:0.8rem}.vx-report-links a{color:var(--vx-plum);font-weight:500;text-decoration:none;border-bottom:1px solid var(--vx-lilac)}.vx-report-links a:hover{border-bottom-color:var(--vx-plum)}.vx-report-links a:first-child::after{content:\" →\"}@media (max-width: 640px){.vx-plans,.vx-stat-row,.vx-wf-grid,.vx-reports{grid-template-columns:1fr}}@media (max-width: 900px){.vx-flow{grid-template-columns:1fr;gap:1rem;height:auto}.vx-sources,.vx-outputs{grid-template-rows:none}.vx-wires{display:none}.vx-node{width:100%;height:auto;flex-direction:row;padding:0.9rem}.vx-node .vx-ico{width:22px;height:22px}}@media (prefers-reduced-motion: reduce){.vx-wires::after{background-image:var(--vx-wire-still)}#content-area .card,.vx-output,.vx-wf,.vx-wf b::after{transition:none}}:is(nav[aria-label=\"Main\"],.navbar-link) a[href=\"/integrations/onboard-agents\"]::after{content:\"\";width:63px;height:18px;flex-shrink:0;margin-left:3px;background:url('/icons/agent-marks-light.svg') center / contain no-repeat}.dark :is(nav[aria-label=\"Main\"],.navbar-link) a[href=\"/integrations/onboard-agents\"]::after{background-image:url('/icons/agent-marks-dark.svg')}:is(nav[aria-label=\"Main\"],.navbar-link) a:focus-visible{outline:2px solid var(--vx-plum-soft);outline-offset:5px}#content-area a:focus-visible{outline:2px solid var(--vx-plum-soft);outline-offset:3px}.agent-deeplinks{display:flex;flex-wrap:wrap;gap:0.5rem;margin:1.25rem 0 1.5rem}.agent-deeplink{display:inline-flex;align-items:center;gap:0.5rem;padding:0.8rem 1.15rem;border:1px solid rgba(60, 31, 53, 0.16);background:#fff;font-size:0.9375rem;font-weight:600;color:#17141A;text-decoration:none;white-space:nowrap;cursor:pointer;transition:border-color 0.15s ease, background 0.15s ease, transform 0.15s ease,\n box-shadow 0.15s ease}.agent-deeplink:hover{border-color:#9A6E8F;background:rgba(154, 110, 143, 0.05);color:#17141A;text-decoration:none;transform:translateY(-1px);box-shadow:0 6px 16px -8px rgba(23, 20, 26, 0.28)}.agent-mark{display:block;width:22px;height:22px;flex-shrink:0;background-color:#D97757;-webkit-mask:var(--vx-ico-src) center / contain no-repeat;mask:var(--vx-ico-src) center / contain no-repeat}.agent-mark-mono{background-color:#000}.agent-arrow{font-size:0.8125rem;opacity:0.35;transition:opacity 0.15s ease, transform 0.15s ease}.agent-deeplink:hover .agent-arrow{opacity:0.85;transform:translate(1px, -1px)}.agent-deeplink-plain{border-style:dashed;font-weight:500;color:#6b6570}.dark .agent-deeplink{border-color:rgba(255, 255, 255, 0.14);background:rgba(255, 255, 255, 0.03);color:#E6DCE3}.dark .agent-deeplink:hover{border-color:#CBB1C4;background:rgba(203, 177, 196, 0.1);color:#fff}.dark .agent-mark-mono{background-color:#fff}.dark img[src$=\"/icons/mcp.svg\"]{filter:invert(1)}.dark .agent-deeplink-plain{color:#A9A2AE}.dark #sidebar-content img[src$=\".png\"]{filter:invert(1)}.docs-sidebar-cta{--cta-background: #2A1524;--cta-border: rgba(255, 255, 255, 0.14);--cta-text: #FFFFFF;--cta-muted: #D8C6D3;margin-top:24px!important;padding:20px;border:1px solid var(--cta-border);border-radius:12px;background:var(--cta-background);color:var(--cta-text);font-size:14px;line-height:1.5}.docs-sidebar-cta-logo{display:block;width:100px;height:auto;margin-bottom:20px}.docs-sidebar-cta-title{margin:0 0 8px;color:var(--cta-text);font-size:20px;font-weight:600;letter-spacing:-0.4px;line-height:1.3}.docs-sidebar-cta-description,.docs-sidebar-cta-credits{margin:0 0 16px;color:var(--cta-muted)}.docs-sidebar-cta-primary,.docs-sidebar-cta-secondary{display:flex;align-items:center;justify-content:center;position:relative;min-height:44px;padding:10px 32px;border:1px solid transparent;border-radius:6px;font-weight:600;line-height:1.5;text-decoration:none;transition:background-color 150ms, border-color 150ms}.docs-sidebar-cta-primary{background:#C7E04A;color:#2C3400}.docs-sidebar-cta-primary:hover{background:#D6EC73;color:#2C3400}.docs-sidebar-cta-secondary{margin-top:8px;border-color:var(--cta-border);background:transparent;color:var(--cta-text);font-weight:500}.docs-sidebar-cta-secondary:hover{border-color:rgba(255, 255, 255, 0.4);background:#3C1F35;color:var(--cta-text)}.docs-sidebar-cta-primary span,.docs-sidebar-cta-secondary span{position:absolute;right:14px;font-size:16px}.docs-sidebar-cta a:focus-visible{outline:2px solid #C7E04A;outline-offset:3px}.docs-sidebar-cta-note{margin:12px 0 0;color:var(--cta-muted);font-size:12px;text-align:center}@media (prefers-reduced-motion: reduce){.docs-sidebar-cta a{transition:none}}#footer>div{padding-top:2.5rem!important;padding-bottom:1.75rem!important;gap:1.75rem!important}#footer .flex-col.gap-4{gap:0.6rem!important}.vx-report .vx-report-finding{margin-top:0.7rem;padding:0.55rem 0.7rem;background:var(--vx-wash);font-size:0.8rem;color:var(--vx-ink)}.vx-report .vx-report-finding .vx-label{display:block;margin-bottom:0.15rem}.vx-report .vx-report-note{margin-top:0.5rem;font-size:0.74rem;color:var(--vx-muted)}.vx-ico{display:block;background-color:currentColor;-webkit-mask:var(--vx-ico-src) center / contain no-repeat;mask:var(--vx-ico-src) center / contain no-repeat}.vx-ico-search{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221.6%22 stroke-linecap=%22round%22%3E%3Cpath d=%22M18 11a7 7 0 1 1-14 0 7 7 0 0 1 14 0Z%22 /%3E%3Cpath d=%22m20 20-3.5-3.5%22 /%3E%3C/svg%3E\")}.vx-ico-globe{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221.5%22%3E%3Cpath d=%22M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z%22 /%3E%3Cpath d=%22M3 12h18M12 3c2.5 2.6 3.8 5.6 3.8 9s-1.3 6.4-3.8 9c-2.5-2.6-3.8-5.6-3.8-9S9.5 5.6 12 3Z%22 /%3E%3C/svg%3E\")}.vx-ico-file{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221.5%22%3E%3Cpath d=%22M7 3h7l4 4v14H7z%22 /%3E%3Cpath d=%22M14 3v4h4M10 12h5M10 16h5%22 /%3E%3C/svg%3E\")}.vx-ico-book{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221.5%22%3E%3Cpath d=%22M4 5.5C6.5 4.5 9.5 4.5 12 6c2.5-1.5 5.5-1.5 8-.5V19c-2.5-1-5.5-1-8 .5-2.5-1.5-5.5-1.5-8-.5z%22 /%3E%3Cpath d=%22M12 6v13.5%22 /%3E%3C/svg%3E\")}.vx-ico-flask{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221.5%22%3E%3Cpath d=%22M9 3h6M10 3v6l-5 9a2 2 0 0 0 1.8 3h10.4a2 2 0 0 0 1.8-3l-5-9V3%22 /%3E%3Cpath d=%22M7.5 15h9%22 /%3E%3C/svg%3E\")}.vx-ico-valyu{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%222%22 stroke-linejoin=%22miter%22%3E%3Cpath d=%22M3.5 4.5h17L12 20z%22 /%3E%3C/svg%3E\")}.vx-wires-in{--vx-wire-base: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 d=%22M0 19.4 C55 19.4 45 50 100 50%22 /%3E%3Cpath vector-effect=%22non-scaling-stroke%22 d=%22M0 66.2 C55 66.2 45 50 100 50%22 /%3E%3C/svg%3E\");--vx-wire-live: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 42.8 C55 42.8 45 50 100 50%22 /%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 89.6 C55 89.6 45 50 100 50%22 /%3E%3Cstyle%3Epath%7Banimation:d 1.6s linear infinite%7D%40keyframes d%7Bto%7Bstroke-dashoffset:-24%7D%7D%3C/style%3E%3C/svg%3E\");--vx-wire-still: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 42.8 C55 42.8 45 50 100 50%22 /%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 89.6 C55 89.6 45 50 100 50%22 /%3E%3C/svg%3E\")}.vx-wires-out{--vx-wire-base: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22 stroke=%22%23000%22 stroke-width=%221%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 d=%22M0 50 C45 50 55 76 100 76%22 /%3E%3C/svg%3E\");--vx-wire-live: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 50 C45 50 55 24 100 24%22 /%3E%3Cstyle%3Epath%7Banimation:d 1.6s linear infinite%7D%40keyframes d%7Bto%7Bstroke-dashoffset:-24%7D%7D%3C/style%3E%3C/svg%3E\");--vx-wire-still: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22 preserveAspectRatio=%22none%22 fill=%22none%22%3E%3Cpath vector-effect=%22non-scaling-stroke%22 stroke=%22%23C7E04A%22 stroke-width=%221.5%22 stroke-dasharray=%224 8%22 d=%22M0 50 C45 50 55 24 100 24%22 /%3E%3C/svg%3E\")}.agent-mark-claude{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22%23000%22%3E%3Cpath d=%22m4.7144 15.9555 4.7174-2.6471.079-.2307-.079-.1275h-.2307l-.7893-.0486-2.6956-.0729-2.3375-.0971-2.2646-.1214-.5707-.1215-.5343-.7042.0546-.3522.4797-.3218.686.0608 1.5179.1032 2.2767.1578 1.6514.0972 2.4468.255h.3886l.0546-.1579-.1336-.0971-.1032-.0972L6.973 9.8356l-2.55-1.6879-1.3356-.9714-.7225-.4918-.3643-.4614-.1578-1.0078.6557-.7225.8803.0607.2246.0607.8925.686 1.9064 1.4754 2.4893 1.8336.3643.3035.1457-.1032.0182-.0728-.164-.2733-1.3539-2.4467-1.445-2.4893-.6435-1.032-.17-.6194c-.0607-.255-.1032-.4674-.1032-.7285L6.287.1335 6.6997 0l.9957.1336.419.3642.6192 1.4147 1.0018 2.2282 1.5543 3.0296.4553.8985.2429.8318.091.255h.1579v-.1457l.1275-1.706.2368-2.0947.2307-2.6957.0789-.7589.3764-.9107.7468-.4918.5828.2793.4797.686-.0668.4433-.2853 1.8517-.5586 2.9021-.3643 1.9429h.2125l.2429-.2429.9835-1.3053 1.6514-2.0643.7286-.8196.85-.9046.5464-.4311h1.0321l.759 1.1293-.34 1.1657-1.0625 1.3478-.8804 1.1414-1.2628 1.7-.7893 1.36.0729.1093.1882-.0183 2.8535-.607 1.5421-.2794 1.8396-.3157.8318.3886.091.3946-.3278.8075-1.967.4857-2.3072.4614-3.4364.8136-.0425.0304.0486.0607 1.5482.1457.6618.0364h1.621l3.0175.2247.7892.522.4736.6376-.079.4857-1.2142.6193-1.6393-.3886-3.825-.9107-1.3113-.3279h-.1822v.1093l1.0929 1.0686 2.0035 1.8092 2.5075 2.3314.1275.5768-.3218.4554-.34-.0486-2.2039-1.6575-.85-.7468-1.9246-1.621h-.1275v.17l.4432.6496 2.3436 3.5214.1214 1.0807-.17.3521-.6071.2125-.6679-.1214-1.3721-1.9246L14.38 17.959l-1.1414-1.9428-.1397.079-.674 7.2552-.3156.3703-.7286.2793-.6071-.4614-.3218-.7468.3218-1.4753.3886-1.9246.3157-1.53.2853-1.9004.17-.6314-.0121-.0425-.1397.0182-1.4328 1.9672-2.1796 2.9446-1.7243 1.8456-.4128.164-.7164-.3704.0667-.6618.4008-.5889 2.386-3.0357 1.4389-1.882.929-1.0868-.0062-.1579h-.0546l-6.3385 4.1164-1.1293.1457-.4857-.4554.0608-.7467.2307-.2429 1.9064-1.3114Z%22 /%3E%3C/svg%3E\")}.agent-mark-codex{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22%23000%22%3E%3Cpath d=%22M22.2819 9.8211a5.9847 5.9847 0 0 0-.5157-4.9108 6.0462 6.0462 0 0 0-6.5098-2.9A6.0651 6.0651 0 0 0 4.9807 4.1818a5.9847 5.9847 0 0 0-3.9977 2.9 6.0462 6.0462 0 0 0 .7427 7.0966 5.98 5.98 0 0 0 .511 4.9107 6.051 6.051 0 0 0 6.5146 2.9001A5.9847 5.9847 0 0 0 13.2599 24a6.0557 6.0557 0 0 0 5.7718-4.2058 5.9894 5.9894 0 0 0 3.9977-2.9001 6.0557 6.0557 0 0 0-.7475-7.0729zm-9.022 12.6081a4.4755 4.4755 0 0 1-2.8764-1.0408l.1419-.0804 4.7783-2.7582a.7948.7948 0 0 0 .3927-.6813v-6.7369l2.02 1.1686a.071.071 0 0 1 .038.052v5.5826a4.504 4.504 0 0 1-4.4945 4.4944zm-9.6607-4.1254a4.4708 4.4708 0 0 1-.5346-3.0137l.142.0852 4.783 2.7582a.7712.7712 0 0 0 .7806 0l5.8428-3.3685v2.3324a.0804.0804 0 0 1-.0332.0615L9.74 19.9502a4.4992 4.4992 0 0 1-6.1408-1.6464zM2.3408 7.8956a4.485 4.485 0 0 1 2.3655-1.9728V11.6a.7664.7664 0 0 0 .3879.6765l5.8144 3.3543-2.0201 1.1685a.0757.0757 0 0 1-.071 0l-4.8303-2.7865A4.504 4.504 0 0 1 2.3408 7.872zm16.5963 3.8558L13.1038 8.364 15.1192 7.2a.0757.0757 0 0 1 .071 0l4.8303 2.7913a4.4944 4.4944 0 0 1-.6765 8.1042v-5.6772a.79.79 0 0 0-.407-.667zm2.0107-3.0231l-.142-.0852-4.7735-2.7818a.7759.7759 0 0 0-.7854 0L9.409 9.2297V6.8974a.0662.0662 0 0 1 .0284-.0615l4.8303-2.7866a4.4992 4.4992 0 0 1 6.6802 4.66zM8.3065 12.863l-2.02-1.1638a.0804.0804 0 0 1-.038-.0567V6.0742a4.4992 4.4992 0 0 1 7.3757-3.4537l-.142.0805L8.704 5.459a.7948.7948 0 0 0-.3927.6813zm1.0976-2.3654l2.602-1.4998 2.6069 1.4998v2.9994l-2.5974 1.4997-2.6067-1.4997Z%22 /%3E%3C/svg%3E\")}.agent-mark-cursor{--vx-ico-src: url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22 fill=%22%23000%22%3E%3Cpath d=%22M11.503.131 1.891 5.678a.84.84 0 0 0-.42.726v11.188c0 .3.162.575.42.724l9.609 5.55a1 1 0 0 0 .998 0l9.61-5.55a.84.84 0 0 0 .42-.724V6.404a.84.84 0 0 0-.42-.726L12.497.131a1.01 1.01 0 0 0-.996 0M2.657 6.338h18.55c.263 0 .43.287.297.515L12.23 22.918c-.062.107-.229.064-.229-.06V12.335a.59.59 0 0 0-.295-.51l-9.11-5.257c-.109-.063-.064-.23.061-.23%22 /%3E%3C/svg%3E\")}"}]}
{"page":{"pagePath":"api-reference/endpoint/deepresearch-edit-create","slug":"/api-reference/endpoint/deepresearch-edit-create","pageMetadata":{"title":"Create Edit","description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","og:title":"DeepResearch - Create Edit | Valyu","og:description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","twitter:title":"DeepResearch - Create Edit | Valyu","twitter:description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","keywords":"Valyu, DeepResearch, edit report, edit deliverable, POST /v1/deepresearch/tasks/{id}/edit","openapi":"POST /v1/deepresearch/tasks/{id}/edit","href":"/api-reference/endpoint/deepresearch-edit-create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/\", \"/edit.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Apply a small, targeted natural-language edit to a completed DeepResearch markdown report or one of its generated deliverable files. Edits make exact replacements so untouched text stays byte-for-byte identical, and new citations only reference sources the task already gathered.`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`wait_seconds`}),` (`,_jsx(_components.code,{children:`0`}),` to `,_jsx(_components.code,{children:`20`}),`) to wait inline for completion. If the edit finishes within that window, the endpoint returns `,_jsx(_components.code,{children:`200`}),` with the full edit record. Otherwise it returns `,_jsx(_components.code,{children:`202`}),` with `,_jsx(_components.code,{children:`edit_id`}),` and `,_jsx(_components.code,{children:`retry_after_seconds`}),`; poll `,_jsx(_components.a,{href:`/api-reference/endpoint/deepresearch-edit-get`,children:`Get edit`}),` until `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`applied`}),`, `,_jsx(_components.code,{children:`declined`}),`, or `,_jsx(_components.code,{children:`failed`}),`. Pass an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header so retries after a timeout return the same edit.`]}),`\n`,_jsx(Heading,{level:`2`,id:`rules`,children:`Rules`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Owner only:`}),` Only the task owner can submit edits. Shared and public viewers receive `,_jsx(_components.code,{children:`403`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Completed markdown reports:`}),` The task must be `,_jsx(_components.code,{children:`completed`}),` and must produce a markdown report (not a structured JSON-schema output). Check `,_jsx(_components.code,{children:`editable`}),` in `,_jsx(_components.a,{href:`/api-reference/endpoint/deepresearch-status`,children:`Get status`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`One edit at a time:`}),` Only one edit or restore runs at a time per task. Concurrent requests return `,_jsx(_components.code,{children:`409`}),` with `,_jsx(_components.code,{children:`edit.in_progress`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Strict request body:`}),` Unknown fields are rejected with `,_jsx(_components.code,{children:`400`}),` `,_jsx(_components.code,{children:`edit.invalid_request`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Optimistic concurrency:`}),` Send `,_jsx(_components.code,{children:`base_version`}),` to guard against concurrent edits; if the head has moved on, the endpoint returns `,_jsx(_components.code,{children:`409`}),` with `,_jsx(_components.code,{children:`edit.revision_conflict`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`error-and-decline-codes`,children:`Error and decline codes`}),`\n`,_jsxs(_components.p,{children:[`Request errors return a `,_jsx(_components.code,{children:`4xx`}),` status before an edit runs. Content-level refusals finish with `,_jsx(_components.code,{children:`200`}),` and `,_jsx(_components.code,{children:`status: \"declined\"`}),` with `,_jsx(_components.code,{children:`decline: { code, message, suggestion }`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP / Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.invalid_request`})}),_jsx(_components.td,{children:`Invalid field, unknown JSON field, or mismatched offset pair`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`Caller is not the task owner`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`Task not found, or editing is not enabled`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.task_not_completed`})}),_jsxs(_components.td,{children:[`Task is not in `,_jsx(_components.code,{children:`completed`}),` state`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.in_progress`})}),_jsx(_components.td,{children:`Another edit or restore is running on this task`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.revision_conflict`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`base_version`}),` does not match the current head`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.unsupported_task`})}),_jsx(_components.td,{children:`Task output is not an editable markdown report`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`focus.not_found`})}),_jsx(_components.td,{children:`Focused passage or section could not be found (nothing ran)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`focus.ambiguous`})}),_jsxs(_components.td,{children:[`Focus matched multiple locations; body includes `,_jsx(_components.code,{children:`candidates[]`}),` (nothing ran)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.busy`})}),_jsx(_components.td,{children:`Temporary capacity limit; retry later`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.rewrite_requested`})}),_jsx(_components.td,{children:`Change exceeds the edit cap; start a new task instead`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.out_of_evidence`})}),_jsx(_components.td,{children:`Requires information the task’s research did not gather`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.contradictory`})}),_jsx(_components.td,{children:`Instruction is self-contradictory or conflicts with constraints`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.unsafe_instruction`})}),_jsx(_components.td,{children:`Instruction cannot be safely carried out`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.not_applicable`})}),_jsx(_components.td,{children:`Instruction does not apply to the target or focus`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`declined`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`edit.no_change`})}),_jsx(_components.td,{children:`Target already matches the instruction`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/guides/deepresearch-editing`,children:`Edit a finished report`}),` for a full walkthrough of report and deliverable edits, focus matching, and agent workflows.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Edit","description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","og:title":"DeepResearch - Create Edit | Valyu","og:description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","twitter:title":"DeepResearch - Create Edit | Valyu","twitter:description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","keywords":"Valyu, DeepResearch, edit report, edit deliverable, POST /v1/deepresearch/tasks/{id}/edit","openapi":"POST /v1/deepresearch/tasks/{id}/edit","href":"/api-reference/endpoint/deepresearch-edit-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Rules","slug":"rules","depth":2,"children":[]},{"title":"Error and decline codes","slug":"error-and-decline-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/valyu/10e5b40d4d63eeec/custom.js","/_mintlify/custom/valyu/de07148e46689f3a/cta-attribution.js"],"openApiReferenceData":{"operation":{"operationId":"createDeepResearchEdit","summary":"Edit a completed report or deliverable","description":"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.","tags":["DeepResearch"],"parameters":["ff3bc608-cd88-4213-895b-51acab2a70f3","fb7588d9-1ae8-468a-91c8-2cfc674a14b4"],"requestBody":"68b4c6b3-94b4-425a-a2c3-646ec4f75ca8","responses":{"200":"cc72d5dc-3f72-40ca-b0d2-908cd910315d","202":"bada5ca8-9bf7-4854-b855-36a4936bbf7f","400":"a74e11d2-c623-4366-9873-e3b5c1021fa5","401":"0335f1bf-a59c-4c13-b18a-bc69eea691bc","403":"f61ab06f-77ba-4799-8e75-1129044c083b","404":"732dfb12-ff56-4b93-a1bc-3b883cbac496","409":"4c969f4e-c1bf-48db-847b-c0245705e35f","422":"370375eb-fb53-4a0a-9e47-8bd5d3abfe41","429":"3e71d0b4-b96d-48db-b769-36834a45b48e","500":"bc68e7ad-ea6c-494d-a02b-14f77994365c"},"method":"post","type":"path","servers":["5c79bd7d-3d0c-4d75-84fd-9ae5ec5a00cb"],"security":["84b82f72-aa5c-41a5-b5cd-ff37871d5319"],"path":"/v1/deepresearch/tasks/{id}/edit","baseUrlOptions":["https://api.valyu.ai"],"title":"Edit a completed report or deliverable","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ff3bc608-cd88-4213-895b-51acab2a70f3":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"DeepResearch task ID.","uniqueKey":"","typeLabel":"string"},"description":"DeepResearch task ID.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"fb7588d9-1ae8-468a-91c8-2cfc674a14b4":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional idempotency key. Replaying the request with the same key returns the same edit instead of starting a duplicate.","uniqueKey":"","typeLabel":"string"},"description":"Optional idempotency key. Replaying the request with the same key returns the same edit instead of starting a duplicate.","example":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request body for editing a completed DeepResearch report or deliverable. Unknown fields are rejected with `400` `edit.invalid_request`.","required":["instruction"],"properties":{"instruction":{"type":"string","minLength":1,"maxLength":4000,"description":"Plain-English description of the change to make.","example":"Cut the executive summary to 3 bullets and add the Q3 revenue figure with its citation.","isRequired":true,"uniqueKey":"instruction","typeLabel":"string"},"target":{"oneOf":[{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Edit the written markdown report.","isRequired":true,"uniqueKey":"target.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"target.oneOf.0","typeLabel":"object"},{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind","deliverable_id"],"properties":{"kind":{"type":"string","enum":["deliverable"],"description":"Edit one of the task's generated deliverable files.","isRequired":true,"uniqueKey":"target.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"deliverable_id":{"type":"string","description":"Deliverable ID from the task's `deliverables` list (for example `f_01`, `f_02`).","example":"f_01","isRequired":true,"uniqueKey":"target.oneOf.1.deliverable_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"target.oneOf.1","typeLabel":"object"}],"uniqueKey":"target","typeLabel":"object"},"focus":{"type":"object","additionalProperties":false,"description":"Optional pointer to a passage or section in the report.","properties":{"start_char":{"type":"integer","minimum":0,"description":"Start UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `end_char`, with `end_char > start_char`.","example":1840,"uniqueKey":"focus.start_char","typeLabel":"integer"},"end_char":{"type":"integer","minimum":1,"description":"End UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `start_char`, with `end_char > start_char`.","example":1965,"uniqueKey":"focus.end_char","typeLabel":"integer"},"text":{"type":"string","maxLength":20000,"description":"Highlighted text to focus on. Offsets are trusted when `text` matches; otherwise `text` is searched for and narrowed by `prefix`, `suffix`, `section`, and the offset hint.","uniqueKey":"focus.text","typeLabel":"string"},"prefix":{"type":"string","maxLength":2000,"description":"Text immediately before the passage to disambiguate matches.","uniqueKey":"focus.prefix","typeLabel":"string"},"suffix":{"type":"string","maxLength":2000,"description":"Text immediately after the passage to disambiguate matches.","uniqueKey":"focus.suffix","typeLabel":"string"},"section":{"type":"string","minLength":1,"maxLength":300,"description":"Section heading. Sent alone, focuses that whole section.","example":"Executive Summary","uniqueKey":"focus.section","typeLabel":"string"},"scope":{"type":"string","enum":["prefer","strict"],"default":"prefer","description":"`prefer` points the editor at the focused region (default). `strict` rejects changes outside the focus.","uniqueKey":"focus.scope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"focus","typeLabel":"object"},"base_version":{"type":"integer","minimum":1,"description":"Version number you are editing. If the task head has moved on, the endpoint returns `409` `edit.revision_conflict`.","example":1,"uniqueKey":"base_version","typeLabel":"integer"},"citations":{"type":"string","enum":["stable","compact"],"default":"stable","description":"`stable` (default) keeps existing citation numbers, appends new citations after the highest used, and retires dropped ones. `compact` renumbers citations by first use.","uniqueKey":"citations","typeLabel":"enum\u003cstring>"},"wait_seconds":{"type":"number","minimum":0,"maximum":20,"description":"Seconds to wait inline for the edit to finish (0 to 20). Returns `200` with the full edit record if finished in time, otherwise `202`.","example":15,"uniqueKey":"wait_seconds","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"report_section":{"title":"report_section","summary":"Edit a specific report section","value":{"instruction":"Cut the executive summary to 3 bullets and add the Q3 revenue figure with its citation.","focus":{"section":"Executive Summary","scope":"strict"},"base_version":1,"citations":"stable","wait_seconds":15}},"highlighted_passage":{"title":"highlighted_passage","summary":"Edit a highlighted passage with offsets and context","value":{"instruction":"Add a caveat that margin guidance excludes pending acquisitions.","focus":{"start_char":1840,"end_char":1965,"text":"Management expects operating margin to expand by 250 bps in FY2027.","prefix":"## Outlook\n\n","suffix":" Capital expenditure is projected to remain flat.","section":"Outlook","scope":"strict"},"base_version":1}},"deliverable":{"title":"deliverable","summary":"Edit a generated deliverable file","value":{"instruction":"Add a YoY growth % column to the Revenue Comparison sheet and format it with one decimal place.","target":{"kind":"deliverable","deliverable_id":"f_01"},"base_version":2,"wait_seconds":20}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"cc72d5dc-3f72-40ca-b0d2-908cd910315d":{"description":"Edit finished within `wait_seconds` (or replayed via `Idempotency-Key` after finishing). Check `status` (`applied`, `declined`, or `failed`).","content":{"application/json":{"schema":{"type":"object","description":"Full record of a DeepResearch edit.","required":["edit_id","deepresearch_id","status","target","base_version","created_at"],"properties":{"edit_id":{"type":"string","description":"Unique identifier for this edit.","example":"ed_01j9x4k2m8n7p3q5r6s8t0v2w4","isRequired":true,"uniqueKey":"edit_id","typeLabel":"string"},"deepresearch_id":{"type":"string","description":"DeepResearch task ID.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"deepresearch_id","typeLabel":"string"},"status":{"type":"string","enum":["running","applied","declined","failed"],"description":"Lifecycle status of the edit.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"target":{"oneOf":[{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Edit the written markdown report.","isRequired":true,"uniqueKey":"target.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"target.oneOf.0","typeLabel":"object"},{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind","deliverable_id"],"properties":{"kind":{"type":"string","enum":["deliverable"],"description":"Edit one of the task's generated deliverable files.","isRequired":true,"uniqueKey":"target.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"deliverable_id":{"type":"string","description":"Deliverable ID from the task's `deliverables` list (for example `f_01`, `f_02`).","example":"f_01","isRequired":true,"uniqueKey":"target.oneOf.1.deliverable_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"target.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"target","typeLabel":"object"},"base_version":{"type":"integer","minimum":1,"description":"Version number the edit was applied against.","isRequired":true,"uniqueKey":"base_version","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the edit was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"version":{"oneOf":[{"type":"integer","minimum":1,"description":"New version number created when `status` is `applied`.","uniqueKey":"version.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"New version number created when `status` is `applied`.","uniqueKey":"version.oneOf.1","typeLabel":"null"}],"uniqueKey":"version","typeLabel":"integer | null"},"focus":{"oneOf":[{"type":"object","description":"Focus supplied in the edit request, if any.","properties":{"start_char":{"type":"integer","minimum":0,"description":"Start UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `end_char`, with `end_char > start_char`.","example":1840,"uniqueKey":"focus.oneOf.0.start_char","typeLabel":"integer"},"end_char":{"type":"integer","minimum":1,"description":"End UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `start_char`, with `end_char > start_char`.","example":1965,"uniqueKey":"focus.oneOf.0.end_char","typeLabel":"integer"},"text":{"type":"string","maxLength":20000,"description":"Highlighted text to focus on. Offsets are trusted when `text` matches; otherwise `text` is searched for and narrowed by `prefix`, `suffix`, `section`, and the offset hint.","uniqueKey":"focus.oneOf.0.text","typeLabel":"string"},"prefix":{"type":"string","maxLength":2000,"description":"Text immediately before the passage to disambiguate matches.","uniqueKey":"focus.oneOf.0.prefix","typeLabel":"string"},"suffix":{"type":"string","maxLength":2000,"description":"Text immediately after the passage to disambiguate matches.","uniqueKey":"focus.oneOf.0.suffix","typeLabel":"string"},"section":{"type":"string","minLength":1,"maxLength":300,"description":"Section heading. Sent alone, focuses that whole section.","example":"Executive Summary","uniqueKey":"focus.oneOf.0.section","typeLabel":"string"},"scope":{"type":"string","enum":["prefer","strict"],"default":"prefer","description":"`prefer` points the editor at the focused region (default). `strict` rejects changes outside the focus.","uniqueKey":"focus.oneOf.0.scope","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"focus.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"focus.oneOf.1","typeLabel":"null"}],"uniqueKey":"focus","typeLabel":"object | null"},"retry_after_seconds":{"oneOf":[{"type":"number","description":"Suggested polling delay in seconds while `status` is `running`.","uniqueKey":"retry_after_seconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Suggested polling delay in seconds while `status` is `running`.","uniqueKey":"retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retry_after_seconds","typeLabel":"number | null"},"summary":{"oneOf":[{"type":"string","description":"Short summary of the result.","uniqueKey":"summary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short summary of the result.","uniqueKey":"summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"summary","typeLabel":"string | null"},"changes":{"type":"array","maxItems":50,"description":"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.","items":{"type":"object","required":["line","removed","added"],"additionalProperties":false,"properties":{"line":{"type":"integer","minimum":1,"description":"1-based line in the base version's output where the change begins.","isRequired":true,"uniqueKey":"changes.items.[INDEX].line","typeLabel":"integer"},"removed":{"type":"array","maxItems":40,"items":{"type":"string","uniqueKey":"changes.items.[INDEX].removed.items.[INDEX]","typeLabel":"string"},"description":"Whole lines removed from the base version, in order. Empty for a pure insertion.","isRequired":true,"uniqueKey":"changes.items.[INDEX].removed","typeLabel":"string[]"},"added":{"type":"array","maxItems":40,"items":{"type":"string","uniqueKey":"changes.items.[INDEX].added.items.[INDEX]","typeLabel":"string"},"description":"Whole lines that replace them in the new version, in order. Empty for a pure deletion.","isRequired":true,"uniqueKey":"changes.items.[INDEX].added","typeLabel":"string[]"}},"uniqueKey":"changes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"changes","typeLabel":"object[]"},"unapplied":{"type":"array","description":"Parts of the instruction that could not be applied.","items":{"oneOf":[{"type":"string","uniqueKey":"unapplied.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"unapplied.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"unapplied.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"unapplied","typeLabel":"(string | object)[]"},"stats":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Metrics for the edit (such as replacement count and characters changed).","uniqueKey":"stats.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Metrics for the edit (such as replacement count and characters changed).","uniqueKey":"stats.oneOf.1","typeLabel":"null"}],"uniqueKey":"stats","typeLabel":"object | null"},"warnings":{"type":"array","description":"Warnings produced by the edit, such as `deliverables_stale` when a report edit runs on a task with deliverable files.","items":{"type":"object","description":"Something the request skipped or adjusted. A warning means the request succeeded. New `type` values may be added at any time, so handle unknown ones by showing `message`. See [Warnings](https://docs.valyu.ai/api-reference/warnings).","required":["type","message"],"properties":{"type":{"type":"string","description":"Stable snake_case warning type, for example `datasets_not_in_plan`. New types may be added at any time.","example":"datasets_not_in_plan","isRequired":true,"uniqueKey":"warnings.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","description":"Self-contained sentence, safe to show a user or for an agent to relay as-is.","example":"Your Pay-as-you-go plan doesn't include valyu/valyu-chemrxiv (Comfortably Pro, $99/mo), so it was skipped. Results come from your other sources. Comfortably Pro ($99/mo) includes it: https://platform.valyu.ai/user/account/billing?tab=plan","isRequired":true,"uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","description":"Optional type-specific structured fields, including any URLs.","additionalProperties":true,"example":{"datasets":[{"id":"valyu/valyu-chemrxiv","required_plan":"tier_2"}],"current_plan":"tier_0","required_plan":{"id":"tier_2","name":"Comfortably Pro","price":"$99/mo"},"upgrade_url":"https://platform.valyu.ai/user/account/billing?tab=plan"},"uniqueKey":"warnings.items.[INDEX].detail.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional type-specific structured fields, including any URLs.","additionalProperties":true,"example":{"datasets":[{"id":"valyu/valyu-chemrxiv","required_plan":"tier_2"}],"current_plan":"tier_0","required_plan":{"id":"tier_2","name":"Comfortably Pro","price":"$99/mo"},"upgrade_url":"https://platform.valyu.ai/user/account/billing?tab=plan"},"uniqueKey":"warnings.items.[INDEX].detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"warnings.items.[INDEX].detail","typeLabel":"object | null"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"decline":{"oneOf":[{"type":"object","description":"Present when `status` is `declined`.","required":["code","message"],"properties":{"code":{"type":"string","enum":["edit.rewrite_requested","edit.out_of_evidence","edit.contradictory","edit.unsafe_instruction","edit.not_applicable","edit.no_change"],"description":"Machine-readable decline code.","isRequired":true,"uniqueKey":"decline.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation of why the edit was declined.","isRequired":true,"uniqueKey":"decline.oneOf.0.message","typeLabel":"string"},"suggestion":{"oneOf":[{"type":"string","description":"Suggested next step for the caller or user.","uniqueKey":"decline.oneOf.0.suggestion.oneOf.0","typeLabel":"string"},{"type":"null","description":"Suggested next step for the caller or user.","uniqueKey":"decline.oneOf.0.suggestion.oneOf.1","typeLabel":"null"}],"uniqueKey":"decline.oneOf.0.suggestion","typeLabel":"string | null"}},"uniqueKey":"decline.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"decline.oneOf.1","typeLabel":"null"}],"uniqueKey":"decline","typeLabel":"object | null"},"error":{"oneOf":[{"type":"object","description":"Present when `status` is `failed`.","properties":{"code":{"type":"string","description":"Stable error code, such as `edit.interrupted` when interrupted by a restart.","example":"edit.interrupted","uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable failure detail.","uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether submitting the edit again may succeed.","uniqueKey":"error.oneOf.0.retryable","typeLabel":"boolean"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"},"pdf_url":{"oneOf":[{"type":"string","format":"uri","description":"URL to the re-rendered PDF for the new version when the task has a PDF.","uniqueKey":"pdf_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to the re-rendered PDF for the new version when the task has a PDF.","uniqueKey":"pdf_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"pdf_url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"applied":{"title":"applied","summary":"Applied edit record","value":{"edit_id":"ed_01j9x4k2m8n7p3q5r6s8t0v2w4","deepresearch_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"applied","target":{"kind":"report"},"base_version":1,"version":2,"focus":{"section":"Executive Summary","scope":"strict"},"created_at":"2026-11-19T14:20:00.000Z","summary":"Condensed the Executive Summary to 3 bullets and added the Q3 revenue figure with citation [14].","changes":[{"section":"Executive Summary","description":"Replaced the 6-bullet summary with 3 bullets and added Q3 revenue cited to [14]."}],"unapplied":[],"stats":{"replacements":1,"chars_changed":412,"citations_added":1},"warnings":[],"pdf_url":"https://api.valyu.ai/v1/deepresearch/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/assets/report.pdf?version=2"}},"declined":{"title":"declined","summary":"Declined edit record","value":{"edit_id":"ed_01j9x4m9a1b2c3d4e5f6g7h8j9","deepresearch_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"declined","target":{"kind":"report"},"base_version":2,"created_at":"2026-11-19T14:25:00.000Z","summary":"Could not add Q4 guidance because the task's gathered sources do not contain it.","changes":[],"unapplied":["Add Q4 2026 guidance figures"],"warnings":[],"decline":{"code":"edit.out_of_evidence","message":"The requested Q4 2026 guidance was not found in the sources gathered by this task.","suggestion":"Start a new DeepResearch task targeting Q4 2026 guidance."}}}},"exampleType":"examples"}},"exampleType":"examples"},"bada5ca8-9bf7-4854-b855-36a4936bbf7f":{"description":"Edit accepted and still running. Poll `GET /v1/deepresearch/tasks/{id}/edits/{edit_id}` after `retry_after_seconds`.","content":{"application/json":{"schema":{"type":"object","description":"Accepted edit returned with HTTP `202` while the edit is running.","required":["edit_id","deepresearch_id","status","target","base_version","created_at"],"properties":{"edit_id":{"type":"string","description":"Unique identifier for this edit.","example":"ed_01j9x4k2m8n7p3q5r6s8t0v2w4","isRequired":true,"uniqueKey":"edit_id","typeLabel":"string"},"deepresearch_id":{"type":"string","description":"DeepResearch task ID.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"deepresearch_id","typeLabel":"string"},"status":{"type":"string","enum":["running"],"description":"Current edit status.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"target":{"oneOf":[{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Edit the written markdown report.","isRequired":true,"uniqueKey":"target.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"target.oneOf.0","typeLabel":"object"},{"type":"object","description":"What to edit: the written report (`{\"kind\": \"report\"}`, default) or a specific deliverable file (`{\"kind\": \"deliverable\", \"deliverable_id\": \"f_01\"}`).","required":["kind","deliverable_id"],"properties":{"kind":{"type":"string","enum":["deliverable"],"description":"Edit one of the task's generated deliverable files.","isRequired":true,"uniqueKey":"target.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"deliverable_id":{"type":"string","description":"Deliverable ID from the task's `deliverables` list (for example `f_01`, `f_02`).","example":"f_01","isRequired":true,"uniqueKey":"target.oneOf.1.deliverable_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"target.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"target","typeLabel":"object"},"base_version":{"type":"integer","minimum":1,"description":"Version number the edit was started against.","isRequired":true,"uniqueKey":"base_version","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the edit was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"focus":{"oneOf":[{"type":"object","description":"Focus supplied in the edit request, if any.","properties":{"start_char":{"type":"integer","minimum":0,"description":"Start UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `end_char`, with `end_char > start_char`.","example":1840,"uniqueKey":"focus.oneOf.0.start_char","typeLabel":"integer"},"end_char":{"type":"integer","minimum":1,"description":"End UTF-16 offset into the `output` markdown of `base_version`. Must be given together with `start_char`, with `end_char > start_char`.","example":1965,"uniqueKey":"focus.oneOf.0.end_char","typeLabel":"integer"},"text":{"type":"string","maxLength":20000,"description":"Highlighted text to focus on. Offsets are trusted when `text` matches; otherwise `text` is searched for and narrowed by `prefix`, `suffix`, `section`, and the offset hint.","uniqueKey":"focus.oneOf.0.text","typeLabel":"string"},"prefix":{"type":"string","maxLength":2000,"description":"Text immediately before the passage to disambiguate matches.","uniqueKey":"focus.oneOf.0.prefix","typeLabel":"string"},"suffix":{"type":"string","maxLength":2000,"description":"Text immediately after the passage to disambiguate matches.","uniqueKey":"focus.oneOf.0.suffix","typeLabel":"string"},"section":{"type":"string","minLength":1,"maxLength":300,"description":"Section heading. Sent alone, focuses that whole section.","example":"Executive Summary","uniqueKey":"focus.oneOf.0.section","typeLabel":"string"},"scope":{"type":"string","enum":["prefer","strict"],"default":"prefer","description":"`prefer` points the editor at the focused region (default). `strict` rejects changes outside the focus.","uniqueKey":"focus.oneOf.0.scope","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"focus.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"focus.oneOf.1","typeLabel":"null"}],"uniqueKey":"focus","typeLabel":"object | null"},"retry_after_seconds":{"type":"number","description":"Suggested polling delay in seconds.","example":3,"uniqueKey":"retry_after_seconds","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"running":{"title":"running","summary":"Edit accepted and running","value":{"edit_id":"ed_01j9x4k2m8n7p3q5r6s8t0v2w4","deepresearch_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"running","target":{"kind":"report"},"base_version":1,"focus":{"section":"Executive Summary","scope":"strict"},"created_at":"2026-11-19T14:20:00.000Z","retry_after_seconds":3}}},"exampleType":"examples"}},"exampleType":"examples"},"a74e11d2-c623-4366-9873-e3b5c1021fa5":{"description":"Invalid request body, unknown JSON field, or invalid field values (`edit.invalid_request`).","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_request":{"title":"invalid_request","summary":"Invalid edit request","value":{"error":"Unknown field 'extra' in request body","code":"edit.invalid_request"}}},"exampleType":"examples"}},"exampleType":"examples"},"0335f1bf-a59c-4c13-b18a-bc69eea691bc":{"description":"Missing or invalid API key. Send your key in the `X-API-Key` header.","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing_or_invalid":{"title":"missing_or_invalid","summary":"Missing or invalid API key","value":{"error":"Unauthorized","message":"API key is missing or invalid"}},"invalid_key":{"title":"invalid_key","summary":"Invalid API key (endpoint response)","value":{"success":false,"error":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"f61ab06f-77ba-4799-8e75-1129044c083b":{"description":"Only the task owner can edit a task. Shared and public viewers receive `403`.","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","success":false,"message":"\u003cstring>","code":"insufficient_credits","recovery":{},"transaction_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"732dfb12-ff56-4b93-a1bc-3b883cbac496":{"description":"Task not found, or report editing is not enabled.","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","success":false,"message":"\u003cstring>","code":"insufficient_credits","recovery":{},"transaction_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4c969f4e-c1bf-48db-847b-c0245705e35f":{"description":"Conflict with current task state or version (`edit.task_not_completed`, `edit.in_progress`, `edit.revision_conflict`, or `edit.unsupported_task`).","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"revision_conflict":{"title":"revision_conflict","summary":"Base version behind current head","value":{"error":"Task is at version 2; base_version 1 is stale.","code":"edit.revision_conflict"}},"in_progress":{"title":"in_progress","summary":"Another edit or restore is already running","value":{"error":"An edit is already in progress for this task.","code":"edit.in_progress"}},"task_not_completed":{"title":"task_not_completed","summary":"Task has not completed","value":{"error":"Only completed tasks can be edited.","code":"edit.task_not_completed"}},"unsupported_task":{"title":"unsupported_task","summary":"Task output is not editable","value":{"error":"Structured JSON-schema tasks cannot be edited.","code":"edit.unsupported_task"}}},"exampleType":"examples"}},"exampleType":"examples"},"370375eb-fb53-4a0a-9e47-8bd5d3abfe41":{"description":"Focus could not be matched (`focus.not_found`) or matched multiple places (`focus.ambiguous`, returning `candidates[]` to pick from). Nothing is run.","content":{"application/json":{"schema":{"type":"object","description":"Error body for `422` `focus.not_found` or `focus.ambiguous`. Nothing is run.","required":["error","code"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["focus.not_found","focus.ambiguous"],"description":"Focus resolution error code.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"candidates":{"type":"array","description":"Candidate matches to choose from when `code` is `focus.ambiguous`.","items":{"type":"object","description":"A candidate match returned when `focus` is ambiguous (`422` `focus.ambiguous`).","properties":{"start_char":{"type":"integer","description":"Start UTF-16 offset in `output`.","uniqueKey":"candidates.items.[INDEX].start_char","typeLabel":"integer"},"end_char":{"type":"integer","description":"End UTF-16 offset in `output`.","uniqueKey":"candidates.items.[INDEX].end_char","typeLabel":"integer"},"section":{"oneOf":[{"type":"string","description":"Section heading containing this candidate.","uniqueKey":"candidates.items.[INDEX].section.oneOf.0","typeLabel":"string"},{"type":"null","description":"Section heading containing this candidate.","uniqueKey":"candidates.items.[INDEX].section.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidates.items.[INDEX].section","typeLabel":"string | null"},"prefix":{"type":"string","description":"Surrounding text before this candidate.","uniqueKey":"candidates.items.[INDEX].prefix","typeLabel":"string"},"suffix":{"type":"string","description":"Surrounding text after this candidate.","uniqueKey":"candidates.items.[INDEX].suffix","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"not_found":{"title":"not_found","summary":"Focus text not found","value":{"error":"Could not locate the focused passage in version 1.","code":"focus.not_found"}},"ambiguous":{"title":"ambiguous","summary":"Focus text matched multiple locations","value":{"error":"Focused text matched 2 locations. Pass offsets or prefix/suffix to disambiguate.","code":"focus.ambiguous","candidates":[{"start_char":620,"end_char":655,"section":"Executive Summary","prefix":"In Q3 2026, ","suffix":" across enterprise accounts."},{"start_char":4810,"end_char":4845,"section":"Regional Breakdown","prefix":"In North America, ","suffix":" compared to the prior year."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"3e71d0b4-b96d-48db-b769-36834a45b48e":{"description":"Edit capacity is temporarily busy (`edit.busy`). Retry later.","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"busy":{"title":"busy","summary":"Editor temporarily busy","value":{"error":"Report editor is temporarily busy. Retry later.","code":"edit.busy"}}},"exampleType":"examples"}},"exampleType":"examples"},"bc68e7ad-ea6c-494d-a02b-14f77994365c":{"description":"An unexpected error occurred on the server.","content":{"application/json":{"schema":{"type":"object","description":"Error response. Every error body has `error`. Search, Contents, Answer and Datasources errors usually also carry `success: false`. Errors returned before a request reaches the endpoint (missing, invalid or disabled keys, rate limits) and DeepResearch errors have no `success` field. Some errors add a machine-readable `code` and a `recovery` object.","required":["error"],"properties":{"error":{"type":"string","description":"Error message, or a machine-readable code for some errors (for example `invalid_scope_policy`, or `rate_limited` on a `429`).","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"type":"boolean","description":"`false` when present.","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable detail. Present on errors returned before the request reaches the endpoint.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when available. Branch on this rather than on the message text.","example":"insufficient_credits","uniqueKey":"code","typeLabel":"string"},"recovery":{"type":"object","description":"Links or details that help resolve the error, when available.","additionalProperties":true,"uniqueKey":"recovery","typeLabel":"object"},"transaction_id":{"type":"string","description":"Transaction ID for support, when available.","uniqueKey":"transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","summary":"Internal error","value":{"success":false,"error":"Internal server error. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"84b82f72-aa5c-41a5-b5cd-ff37871d5319":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get yours at [platform.valyu.ai](https://platform.valyu.ai).","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5c79bd7d-3d0c-4d75-84fd-9ae5ec5a00cb":{"url":"https://api.valyu.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get yours at [platform.valyu.ai](https://platform.valyu.ai).","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Get yours at [platform.valyu.ai](https://platform.valyu.ai).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"valyu","siteName":"Valyu","title":"DeepResearch - Create Edit | Valyu","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T21:41:42.125Z","originalFileLocation":"api-reference/endpoint/deepresearch-edit-create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Valyu\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"DeepResearch - Create Edit | Valyu\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Valyu\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://valyu.mintlify.site/_mintlify/api/og/v2?division=DeepResearch\u0026amp;title=Create+Edit\u0026amp;description=Reference+for+editing+a+completed+DeepResearch+report+or+deliverable+via+POST+%2Fv1%2Fdeepresearch%2Ftasks%2F%7Bid%7D%2Fedit.\u0026amp;theme=7528e5ca25897701bdb29a0a\u0026amp;signature=de74319ad6c388fa79e88a95c1fa9580c3efb73f14f65ca23beb57267d19dc12\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"DeepResearch - Create Edit | Valyu\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://valyu.mintlify.site/_mintlify/api/og/v2?division=DeepResearch\u0026amp;title=Create+Edit\u0026amp;description=Reference+for+editing+a+completed+DeepResearch+report+or+deliverable+via+POST+%2Fv1%2Fdeepresearch%2Ftasks%2F%7Bid%7D%2Fedit.\u0026amp;theme=7528e5ca25897701bdb29a0a\u0026amp;signature=de74319ad6c388fa79e88a95c1fa9580c3efb73f14f65ca23beb57267d19dc12\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/valyu/CrEJpfpruXuhNB-H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Valyu\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E3454\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@ValyuOfficial\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"author\" content=\"Valyu\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/deepresearch-edit-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.valyu.ai/#organization\",\"name\":\"Valyu\",\"url\":\"https://www.valyu.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/valyu/XSNGAn-w-x47KJwH/logo/valyu-wordmark-light.svg?fit=max\u0026auto=format\u0026n=XSNGAn-w-x47KJwH\u0026q=85\u0026s=334dd47b5c8dd1f11877b78e19848e24\"},\"sameAs\":[\"https://x.com/ValyuOfficial\",\"https://linkedin.com/company/valyu-ai\",\"https://github.com/valyuAI\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.valyu.ai#website\",\"name\":\"Valyu\",\"url\":\"https://docs.valyu.ai\",\"publisher\":{\"@id\":\"https://www.valyu.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create#webpage\",\"url\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create\",\"name\":\"Create Edit\",\"description\":\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.\",\"dateModified\":\"2026-11-19T21:41:42.125Z\",\"isPartOf\":{\"@id\":\"https://docs.valyu.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"DeepResearch\",\"item\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Edit\",\"item\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create#apireference\",\"headline\":\"Create Edit\",\"name\":\"Create Edit\",\"description\":\"Reference for editing a completed DeepResearch report or deliverable via POST /v1/deepresearch/tasks/{id}/edit.\",\"url\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.valyu.ai/api-reference/endpoint/deepresearch-edit-create#webpage\"},\"dateModified\":\"2026-11-19T21:41:42.125Z\",\"publisher\":{\"@id\":\"https://www.valyu.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.valyu.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Valyu\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Valyu\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/deepresearch-edit-create.md","siteName":"Valyu","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/home"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API essentials","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Warnings","href":"/api-reference/warnings"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"Search","openapi":"POST /v1/search","href":"/api-reference/endpoint/search"}]},{"group":"Contents","icon":"file-lines","pages":[{"title":"Contents","openapi":"POST /v1/contents","href":"/api-reference/endpoint/contents"},{"title":"Contents Job Status","openapi":"GET /v1/contents/jobs/{job_id}","href":"/api-reference/endpoint/contents-job"}]},{"group":"Answer (deprecated)","icon":"message","pages":[{"title":"Answer","deprecated":true,"openapi":"POST /v1/answer","href":"/api-reference/endpoint/answer"}]},{"group":"DeepResearch","icon":"flask","pages":[{"title":"Create Task","openapi":"POST /v1/deepresearch/tasks","href":"/api-reference/endpoint/deepresearch-create"},{"title":"Get Status","openapi":"GET /v1/deepresearch/tasks/{id}/status","href":"/api-reference/endpoint/deepresearch-status"},{"title":"List Tasks","openapi":"GET /v1/deepresearch/list","href":"/api-reference/endpoint/deepresearch-list"},{"title":"Update Task","description":"Reference for adding follow-up instructions to a running task via POST /v1/deepresearch/tasks/\\{id\\}/update.","openapi":"POST /v1/deepresearch/tasks/{id}/update","href":"/api-reference/endpoint/deepresearch-update"},{"title":"Create Edit","openapi":"POST /v1/deepresearch/tasks/{id}/edit","href":"/api-reference/endpoint/deepresearch-edit-create"},{"title":"Get Edit","description":"Reference for polling or inspecting a DeepResearch edit via GET /v1/deepresearch/tasks/{id}/edits/{edit_id}.","openapi":"GET /v1/deepresearch/tasks/{id}/edits/{edit_id}","href":"/api-reference/endpoint/deepresearch-edit-get"},{"title":"List Edits","openapi":"GET /v1/deepresearch/tasks/{id}/edits","href":"/api-reference/endpoint/deepresearch-edit-list"},{"title":"List Versions","openapi":"GET /v1/deepresearch/tasks/{id}/versions","href":"/api-reference/endpoint/deepresearch-versions-list"},{"title":"Restore Version","openapi":"POST /v1/deepresearch/tasks/{id}/versions/{n}/restore","href":"/api-reference/endpoint/deepresearch-versions-restore"},{"title":"Toggle Public Access","openapi":"POST /v1/deepresearch/tasks/{id}/public","href":"/api-reference/endpoint/deepresearch-public"},{"title":"Get Sharing","openapi":"GET /v1/deepresearch/tasks/{id}/share","href":"/api-reference/endpoint/deepresearch-share-get"},{"title":"Update Sharing","openapi":"POST /v1/deepresearch/tasks/{id}/share","href":"/api-reference/endpoint/deepresearch-share-update"},{"title":"Respond to HITL Checkpoint","openapi":"POST /v1/deepresearch/tasks/{id}/respond","href":"/api-reference/endpoint/deepresearch-respond"},{"title":"Cancel Task","openapi":"POST /v1/deepresearch/tasks/{id}/cancel","href":"/api-reference/endpoint/deepresearch-cancel"},{"title":"Delete Task","openapi":"DELETE /v1/deepresearch/tasks/{id}/delete","href":"/api-reference/endpoint/deepresearch-delete"}]},{"group":"DeepResearch (Batch)","icon":"layer-group","pages":[{"title":"Create Batch","openapi":"POST /v1/deepresearch/batches","href":"/api-reference/endpoint/deepresearch-batch-create"},{"title":"List Batches","openapi":"GET /v1/deepresearch/batches","href":"/api-reference/endpoint/deepresearch-batch-list"},{"title":"Get Batch Status","openapi":"GET /v1/deepresearch/batches/{id}","href":"/api-reference/endpoint/deepresearch-batch-status"},{"title":"Add Tasks to Batch","openapi":"POST /v1/deepresearch/batches/{id}/tasks","href":"/api-reference/endpoint/deepresearch-batch-add-tasks"},{"title":"List Batch Tasks","openapi":"GET /v1/deepresearch/batches/{id}/tasks","href":"/api-reference/endpoint/deepresearch-batch-list-tasks"},{"title":"Cancel Batch","openapi":"POST /v1/deepresearch/batches/{id}/cancel","href":"/api-reference/endpoint/deepresearch-batch-cancel"}]},{"group":"Workflows","icon":"diagram-project","tag":"Beta","pages":[{"title":"List Workflows","openapi":"GET /v1/workflows","href":"/api-reference/endpoint/workflows-list"},{"title":"Get Workflow","openapi":"GET /v1/workflows/{slug}","href":"/api-reference/endpoint/workflows-get"},{"title":"Create Workflow","openapi":"POST /v1/workflows","href":"/api-reference/endpoint/workflows-create"},{"title":"Update Workflow","openapi":"PATCH /v1/workflows/{slug}","href":"/api-reference/endpoint/workflows-update"},{"title":"Delete Workflow","openapi":"DELETE /v1/workflows/{slug}","href":"/api-reference/endpoint/workflows-delete"},{"title":"List Workflow Versions","openapi":"GET /v1/workflows/{slug}/versions","href":"/api-reference/endpoint/workflows-versions"},{"title":"Preview Workflow","openapi":"POST /v1/workflows/{slug}/preview","href":"/api-reference/endpoint/workflows-preview"}]},{"group":"Datasources","icon":"database","pages":[{"title":"List Datasources","openapi":"GET /v1/datasources","href":"/api-reference/endpoint/datasources-list"},{"title":"List Categories","openapi":"GET /v1/datasources/categories","href":"/api-reference/endpoint/datasources-categories"},{"title":"Search Datasources","openapi":"GET /v1/datasources/search","href":"/api-reference/endpoint/datasources-search"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog/platform"}]}]},"basePath":"","title":"DeepResearch - Create Edit | Valyu","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}