From b7e7c6a87c0a0e78c4dbcdcc1b1eba0c08c5bad1 Mon Sep 17 00:00:00 2001 From: Rohit Date: Sun, 31 Aug 2025 20:08:45 +0530 Subject: [PATCH] feat: add deep extract api docs --- docs/api/runs.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/api/runs.md b/docs/api/runs.md index 3771aaa..1302fdc 100644 --- a/docs/api/runs.md +++ b/docs/api/runs.md @@ -118,6 +118,20 @@ We encourage you to leverage our webhook support for a more efficient and respon |---|---| | id (required) string | The ID of the robot to run. +#### Request Body (Optional) + +The request body is optional and allows you to specify additional parameters for the robot run: + +```json +{ + "mode": "normal" | "bulk" +} +``` + +| Property | Type | Required | Description | +|---|---|---|---| +| mode | string | No | Extraction mode to use for robots with deep extraction configured. Only applicable when the robot has deep extraction enabled. Choose `bulk` to process all configured deep extraction URLs, or `normal` to run the original robot only. Defaults to the robot's configured mode if not specified. + #### Responses | Code | Description | Media Type