Skip to content
/
Update a task

WebRobot ETL API (1.0.0)

API for managing projects, jobs, datasets, and ETL pipelines on WebRobot.

Authentication

The API uses API Keys for authentication. Include the X-API-Key header in all requests.

Base URL

  • Production: https://api.webrobot.eu/api
  • Development: http://localhost:8020/api

Rate Limiting

Requests are limited to 1000 requests per minute per API key.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
WebRobot Support
support@webrobot.eu
License
Proprietary
Languages
Servers
Mock server
http://docs.webrobot.eu/_mock/openapi/
Production
https://api.webrobot.eu/api/
Local development
http://localhost:8020/api/

Cloud

Operations

Scheduler

Operations

Spark

Operations

Health

Operations

Training

Operations

EAN Plugin

Operations

Jobs

Operations

Bootstrap

Operations

Images

Operations

Info

Operations

Query

Operations

Upload

Operations

AI Providers

Operations

Models

Operations

Datasets

Operations

Agents

Operations

Categories

Operations

Test

Operations

Cloud Credentials

Operations

Tasks

Operations

Get information about the dataset associated with a task

Request

Returns information about the output dataset associated with a specific task.

Security
ApiKeyAuth
Path
taskIdstringrequired

Task ID

Example: 123
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets/query/task/123/info \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Dataset information

Bodyapplication/json
object
Response
application/json
{}

Executes an SQL query on the output dataset of a task

Request

Executes a SQL query on the output dataset associated with a specific task.

Useful for analyzing the results of a task after its execution.

Security
ApiKeyAuth
Path
taskIdstringrequired

Task ID

Example: 123
Bodyapplication/jsonrequired

SQL query to execute

sqlstring

Sql

catalogstring

Catalog

schemastring

Schema

limitinteger(int32)

Limit

offsetinteger(int32)

Offset

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets/query/task/123 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "sql": "string",
    "catalog": "string",
    "schema": "string",
    "limit": 0,
    "offset": 0
  }'

Responses

Query results

Bodyapplication/json
resultsArray of objects
Response
application/json
{
  "results": [
    {}
  ]
}

Get all tasks of a job

Request

Returns the list of all tasks associated with a specific job.

Tasks represent the individual operations that make up an ETL job.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of tasks for the job

Bodyapplication/jsonArray [
idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "jobId": "string",
    "botId": "string",
    "outputDatasetId": "string",
    "taskType": "SPARK",
    "executionReferenceId": "string",
    "executionStatus": "PENDING",
    "executionLog": "string",
    "scheduledTime": "2019-08-24T14:15:22Z",
    "executionMode": "MANUAL",
    "enabled": true,
    "apiKey": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Create a new task in a job

Request

Creates a new task and associates it with an existing job.

A task can be of type SPARK, AUTONOMOUS_AGENT, or BACKGROUND_TASK.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
Bodyapplication/jsonrequired

Task data to create

idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "jobId": "string",
    "botId": "string",
    "outputDatasetId": "string",
    "taskType": "SPARK",
    "executionReferenceId": "string",
    "executionStatus": "PENDING",
    "executionLog": "string",
    "scheduledTime": "2019-08-24T14:15:22Z",
    "executionMode": "MANUAL",
    "enabled": true,
    "apiKey": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }'

Responses

Task created successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "jobId": "string",
  "botId": "string",
  "outputDatasetId": "string",
  "taskType": "SPARK",
  "executionReferenceId": "string",
  "executionStatus": "PENDING",
  "executionLog": "string",
  "scheduledTime": "2019-08-24T14:15:22Z",
  "executionMode": "MANUAL",
  "enabled": true,
  "apiKey": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get a specific task

Request

Returns the details of a specific task, including configurations and execution status.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Task ID

Example: 1
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task details

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "jobId": "string",
  "botId": "string",
  "outputDatasetId": "string",
  "taskType": "SPARK",
  "executionReferenceId": "string",
  "executionStatus": "PENDING",
  "executionLog": "string",
  "scheduledTime": "2019-08-24T14:15:22Z",
  "executionMode": "MANUAL",
  "enabled": true,
  "apiKey": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update a task

Request

Updates the data of an existing task, including configurations and metadata.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Unique ID of the task to update

Example: 1
Bodyapplication/jsonrequired

Updated task data

idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

curl -i -X PUT \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "jobId": "string",
    "botId": "string",
    "outputDatasetId": "string",
    "taskType": "SPARK",
    "executionReferenceId": "string",
    "executionStatus": "PENDING",
    "executionLog": "string",
    "scheduledTime": "2019-08-24T14:15:22Z",
    "executionMode": "MANUAL",
    "enabled": true,
    "apiKey": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }'

Responses

Task updated successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

jobIdstring

Jobid

botIdstring

Botid

outputDatasetIdstring

Outputdatasetid

taskTypestring

Tasktype

Enum"SPARK""AUTONOMOUS_AGENT""BACKGROUND_TASK"
executionReferenceIdstring

Executionreferenceid

executionStatusstring

Executionstatus

Enum"PENDING""RUNNING""COMPLETED""FAILED"
executionLogstring

Executionlog

scheduledTimestring(date-time)

Scheduledtime

executionModestring

Executionmode

Enum"MANUAL""SCHEDULED""EVENT_DRIVEN"
enabledboolean

Enabled

apiKeystring

Apikey

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "jobId": "string",
  "botId": "string",
  "outputDatasetId": "string",
  "taskType": "SPARK",
  "executionReferenceId": "string",
  "executionStatus": "PENDING",
  "executionLog": "string",
  "scheduledTime": "2019-08-24T14:15:22Z",
  "executionMode": "MANUAL",
  "enabled": true,
  "apiKey": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a task

Request

Deletes a task from a job.

Warning: This operation is irreversible. The task will be removed from the job.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Unique ID of the task to delete

Example: 1
curl -i -X DELETE \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task deleted successfully

Bodyapplication/json
object
Response
application/json
{}

Get status of a task

Request

Returns the current status of a task, including execution details and progress.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Task ID

Example: 1
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/status \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task status

Bodyapplication/json
statusstring
Enum"PENDING""RUNNING""COMPLETED""FAILED"
progressnumber(float)

Progress percentage (0-100)

Response
application/json
{
  "status": "PENDING",
  "progress": 0.1
}

Start a task

Request

Starts execution of a specific task.

The task must be of type SPARK, AUTONOMOUS_AGENT, or BACKGROUND_TASK.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Unique ID of the task to start

Example: 1
curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/start \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task started successfully

Bodyapplication/json
object
Response
application/json
{}

Stop a task

Request

Stops execution of a task in progress.

Warning: This operation may interrupt a running task, potentially causing data loss or inconsistency.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Task ID to stop

Example: 1
curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/stop \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task stopped successfully

Bodyapplication/json
object
Response
application/json
{}

Get metrics of a task

Request

Returns detailed metrics for a specific task, including duration, processed records, memory usage, CPU usage, and other performance metrics.

Metrics are extracted from the task executionLog and include:

  • Execution duration
  • Processed and output records
  • Memory usage (driver and executors)
  • CPU usage
  • Error and warning counts
  • Output file size
Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 220
taskIdstringrequired

Task ID

Example: 229
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/220/tasks/229/metrics \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task metrics

Bodyapplication/json
taskIdinteger(int64)

Task ID

durationSecondsinteger(int64)

Execution duration in seconds

recordsProcessedinteger(int64)

Number of processed records

recordsOutputinteger(int64)

Number of output records

outputFileSizeBytesinteger(int64)

Output file size in bytes

driverMemoryUsedBytesinteger(int64)

Memory used by the driver in bytes

executorMemoryUsedBytesinteger(int64)

Memory used by executors in bytes

executorCountinteger(int32)

Number of executors used

totalCpuTimeSecondsinteger(int64)

Total CPU time used in seconds

errorCountinteger(int32)

Number of errors during execution

warningCountinteger(int32)

Number of warnings during execution

statusstring

Final task status

startedAtstring(date-time)

Execution start timestamp

completedAtstring(date-time)

Execution completion timestamp

Response
application/json
{
  "taskId": 0,
  "durationSeconds": 0,
  "recordsProcessed": 0,
  "recordsOutput": 0,
  "outputFileSizeBytes": 0,
  "driverMemoryUsedBytes": 0,
  "executorMemoryUsedBytes": 0,
  "executorCount": 0,
  "totalCpuTimeSeconds": 0,
  "errorCount": 0,
  "warningCount": 0,
  "status": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z"
}

Mark zombie tasks as FAILED

Request

Detects and marks as FAILED tasks that are RUNNING for longer than the specified timeout ("zombie" tasks).

A task is considered a "zombie" if:

  • It has status RUNNING
  • It has been running longer than the specified timeout (default: 24 hours)
  • The startedAt timestamp (or scheduledTime as a fallback) exceeds the timeout

When a task is marked as a zombie:

  • Status is updated to FAILED
  • executionLog is updated with FAILED status, completedAt, and an error message
  • Total execution duration is computed

Note: This endpoint requires admin privileges (scope admin).

Security
ApiKeyAuth
Query
timeoutHoursinteger(int64)

Timeout in hours to consider a task a "zombie" (default: 24). RUNNING tasks exceeding this value will be marked as FAILED.

Default 24
Example: timeoutHours=24
curl -i -X POST \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/admin/tasks/mark-zombies?timeoutHours=24' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Zombie tasks marked successfully

Bodyapplication/json
markedCountinteger(int64)

Number of tasks marked as FAILED

markedTaskIdsArray of integers(int64)

List of task IDs marked as FAILED

timeoutHoursinteger(int64)

Timeout used (in hours)

messagestring

Confirmation message

Example: "Marked 5 zombie task(s) as FAILED"
Response
application/json
{
  "markedCount": 0,
  "markedTaskIds": [
    0
  ],
  "timeoutHours": 0,
  "message": "Marked 5 zombie task(s) as FAILED"
}

Admin

Operations

ETL Library

Operations

Package

Operations

Plugins

Operations

Projects

Operations

ETL Execution

Operations

Execution

Operations

Webhooks

Operations

Metrics

Operations

getHtml

Request

Security
ApiKeyAuth
Path
protocolstringrequired

HTTP protocol (http or https)

urlstringrequired

URL to fetch HTML content from

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/html/{url}/{protocol}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodytext/html

getById

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

update

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

Bodyapplication/json
property name*objectadditional property
curl -i -X PUT \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

delete

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X DELETE \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

findAll

Request

Security
ApiKeyAuth
Path
tablestringrequired
Query
pageinteger(int32)
Default 0
pageSizeinteger(int32)

Number of records per page

Default 50
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}?page=0&pageSize=50' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

insert

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

Bodyapplication/json
property name*objectadditional property
curl -i -X POST \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

getHealth

Request

Security
ApiKeyAuth
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/health \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

Python Extensions

Operations