Skip to content

feat: deep extract api docs #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat: deep extract api docs #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/api/runs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down