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"
}{
"error": "response.answers must be an array"
}{
"success": false,
"error": "Invalid API key"
}{
"success": false,
"error": "Task not found"
}{
"error": "Cannot respond to task with status: running. Task must be in 'awaiting_input' or 'paused' status."
}{
"success": false,
"error": "Internal server error. Please try again later."
}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"
}{
"error": "response.answers must be an array"
}{
"success": false,
"error": "Invalid API key"
}{
"success": false,
"error": "Task not found"
}{
"error": "Cannot respond to task with status: running. Task must be in 'awaiting_input' or 'paused' status."
}{
"success": false,
"error": "Internal server error. Please try again later."
}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?