v1
latestOpenAPI 3.1.02026-07-2658119246.0 KBExtract
Extract Batch
post/v2/extract/batch
Request body
Example request
{
"inputs": [
{
"auto_driver_configuration": {
"vx10": 2,
"vx10-pro": 0,
"vx6-fast": 1,
"vx6-stealth": 1,
"vx8": 5,
"vx8-pro": 5
},
"body": {
"key": "value"
},
"browser": "chrome",
"browser_actions": [
{
"goto": "https://example.com/login"
},
{
"wait_for_element": "#login-form"
},
{
"fill": {
"selector": "#username",
"value": "user@example.com"
}
},
{
"fill": {
"selector": "#password",
"value": "password123"
}
},
{
"click": "#submit"
},
{
"screenshot": {
"full_page": true
}
}
],
"city": "Los Angeles",
"cookies": "sessionId=abc123; userId=user456",
"device": "desktop",
"driver": "vx8",
"expected_status_codes": [
200,
201
],
"formats": [
"html"
],
"headers": {
"Accept-Language": "en-US",
"User-Agent": "CustomBot/1.0"
},
"http2": true,
"is_xhr": true,
"markdown_backend": "full_page",
"method": "GET",
"network_capture": [
{
"resource_type": "document"
}
],
"os": "windows",
"parse": true,
"request_timeout": 30000,
"skill": "dynamic-content",
"state": "CA",
"tag": "campaign-2024-q1",
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
],
"shared_inputs": {
"auto_driver_configuration": {
"vx10": 2,
"vx10-pro": 0,
"vx6-fast": 1,
"vx6-stealth": 1,
"vx8": 5,
"vx8-pro": 5
},
"body": {
"key": "value"
},
"browser": "chrome",
"browser_actions": [
{
"goto": "https://example.com/login"
},
{
"wait_for_element": "#login-form"
},
{
"fill": {
"selector": "#username",
"value": "user@example.com"
}
},
{
"fill": {
"selector": "#password",
"value": "password123"
}
},
{
"click": "#submit"
},
{
"screenshot": {
"full_page": true
}
}
],
"city": "Los Angeles",
"cookies": "sessionId=abc123; userId=user456",
"device": "desktop",
"driver": "vx8",
"expected_status_codes": [
200,
201
],
"formats": [
"html"
],
"headers": {
"Accept-Language": "en-US",
"User-Agent": "CustomBot/1.0"
},
"http2": true,
"is_xhr": true,
"markdown_backend": "full_page",
"method": "GET",
"network_capture": [
{
"resource_type": "document"
}
],
"os": "windows",
"parse": true,
"request_timeout": 30000,
"skill": "dynamic-content",
"state": "CA",
"tag": "campaign-2024-q1",
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
}Response
Batch created successfully
Example response
{
"tasks": [
{
"batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
"created_at": "2024-01-15T10:30:00Z",
"download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
"error": "Connection timeout",
"error_type": "timeout_error",
"id": "123e4567-e89b-12d3-a456-426614174000",
"modified_at": "2024-01-15T10:35:00Z",
"state": "pending",
"status_code": 200,
"status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
}
]
}