DeepResearch

Respond to a HITL checkpoint

Respond to a human-in-the-loop checkpoint. The task must be in awaiting_input or paused status. Pass the interaction_id from the task's interaction field along with the response data matching the checkpoint type.

post/v1/deepresearch/tasks/{id}/respond

Request

  • Base URL: https://api.valyu.ai
  • URL: https://api.valyu.ai/v1/deepresearch/tasks/{id}/respond
  • Auth: API key in header X-API-Key

Path parameters

idstring required

DeepResearch task ID.

Request body

interaction_idstring required

The interaction_id from the task's interaction field.

Example request

{
  "response": {
    "answers": [
      {
        "question": "What geographic regions should the research focus on?",
        "answer": "North America and EU"
      }
    ]
  }
}

Response

Response accepted. Task resumes processing.

successboolean
status'running' | 'queued'

running if container was still alive, queued if task was re-enqueued from paused state.

deepresearch_idstring

Example response

{
  "success": true,
  "status": "running",
  "deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Changes

No recorded changes to this operation across all 1 revision of this API.