curl --request POST \
--url https://api.valyu.ai/v1/deepresearch/tasks/{id}/respond \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"interaction_id": "int_abc123",
"response": {
"answers": [
{
"question": "What geographic regions?",
"answer": "North America and EU"
},
{
"question": "Specific competitors?",
"answer": "Tesla, BYD, Rivian"
}
]
}
}
'{
"success": true,
"status": "running",
"deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}Respond to HITL Checkpoint
Reference for responding to a human-in-the-loop checkpoint via POST /v1/deepresearch/tasks/{id}/respond.
POST
/
v1
/
deepresearch
/
tasks
/
{id}
/
respond
curl --request POST \
--url https://api.valyu.ai/v1/deepresearch/tasks/{id}/respond \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"interaction_id": "int_abc123",
"response": {
"answers": [
{
"question": "What geographic regions?",
"answer": "North America and EU"
},
{
"question": "Specific competitors?",
"answer": "Tesla, BYD, Rivian"
}
]
}
}
'{
"success": true,
"status": "running",
"deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}Resume a task waiting at a human-review checkpoint. Read its current
interaction from Get status, then submit that interaction’s ID and the response shape required for its type.
The task must be in awaiting_input or paused state; otherwise the request returns 409. A 409 with Task is no longer paused. means the task was cancelled while it was being resumed. Do not reuse an interaction ID from an earlier checkpoint.
A paused task needs enough balance to cover its mode price when it resumes. If the balance no longer covers it, the task ends as failed and is not charged. See human-in-the-loop research for the interaction flow.Authorizations
API key for authentication. Get yours at platform.valyu.ai.
Path Parameters
DeepResearch task ID.
Body
application/json
The interaction_id from the task's interaction field.
Response data - shape depends on the checkpoint type (interaction.type).
- Planning Questions Response
- Plan Review Response
- Source Review Response
- Outline Review Response
Show child attributes
Show child attributes
Response
Response accepted. Task resumes processing.
Was this page helpful?