Skip to content
/
Get a specific project

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

Admin

Operations

ETL Library

Operations

Package

Operations

Plugins

Operations

Projects

Operations

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 project

Request

Returns the details of a specific project, including the list of associated jobs.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

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

Responses

Project details

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

cronSchedulestring

Cronschedule

enabledboolean

Enabled

jobIdsArray of strings

Jobids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "cronSchedule": "string",
  "enabled": true,
  "jobIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update a project

Request

Updates the data of an existing project, including configurations and scheduling.

Security
ApiKeyAuth
Path
projectIdstringrequired

Unique ID of the project to update

Example: 98
Bodyapplication/jsonrequired

Updated project data

idstring

Id

namestring

Name

descriptionstring

Description

cronSchedulestring

Cronschedule

enabledboolean

Enabled

jobIdsArray of strings

Jobids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

curl -i -X PUT \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "cronSchedule": "string",
    "enabled": true,
    "jobIds": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }'

Responses

Project updated successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

cronSchedulestring

Cronschedule

enabledboolean

Enabled

jobIdsArray of strings

Jobids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "cronSchedule": "string",
  "enabled": true,
  "jobIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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