Skip to content
/
Update a dataset

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

Upload a dataset for AI training

Request

Uploads a dataset to use for training AI models on the provider specified.

The dataset must be in a format supported by the provider.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
Bodyapplication/jsonrequired

Information on the dataset to upload

localPathstring

Localpath

formatstring

Format

descriptionstring

Description

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/datasets \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "localPath": "string",
    "format": "string",
    "description": "string"
  }'

Responses

Dataset uploaded successfully

Bodyapplication/json
object
Response
application/json
{}

Get all datasets

Request

Returns the list of all datasets available in the system, with support for filters.

Datasets can be filtered by type, format, and indexing status.

Security
ApiKeyAuth
Query
typestring

Filter by dataset type

Example: type=parquet
indexedstring

Filter by indexing status (true/false)

Example: indexed=true
formatstring

Filter by format (parquet, csv, json, etc.)

Example: format=parquet
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets?type=parquet&indexed=true&format=parquet' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of datasets

Bodyapplication/jsonArray [
idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "userId": "string",
    "sourceUrl": "string",
    "sourceType": "string",
    "filePath": "string",
    "fileFormat": "string",
    "fileSize": 0,
    "schema": "string",
    "metadata": "string",
    "enabled": true,
    "fieldIds": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "storagePath": "string",
    "format": "string",
    "datasetType": "string",
    "trinoSchema": "string"
  }
]

Create a new dataset

Request

Creates a new dataset in the system with the specified configurations.

The dataset can be associated with a project and used as input or output for ETL jobs.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Dataset data to create

idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "userId": "string",
    "sourceUrl": "string",
    "sourceType": "string",
    "filePath": "string",
    "fileFormat": "string",
    "fileSize": 0,
    "schema": "string",
    "metadata": "string",
    "enabled": true,
    "fieldIds": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "storagePath": "string",
    "format": "string",
    "datasetType": "string",
    "trinoSchema": "string"
  }'

Responses

Dataset created successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "userId": "string",
  "sourceUrl": "string",
  "sourceType": "string",
  "filePath": "string",
  "fileFormat": "string",
  "fileSize": 0,
  "schema": "string",
  "metadata": "string",
  "enabled": true,
  "fieldIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "storagePath": "string",
  "format": "string",
  "datasetType": "string",
  "trinoSchema": "string"
}

Get a specific dataset

Request

Returns the details of a specific dataset, including information on schema, format and path.

Security
ApiKeyAuth
Path
datasetIdstringrequired

Dataset ID

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

Responses

Dataset details

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "userId": "string",
  "sourceUrl": "string",
  "sourceType": "string",
  "filePath": "string",
  "fileFormat": "string",
  "fileSize": 0,
  "schema": "string",
  "metadata": "string",
  "enabled": true,
  "fieldIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "storagePath": "string",
  "format": "string",
  "datasetType": "string",
  "trinoSchema": "string"
}

Update a dataset

Request

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

Security
ApiKeyAuth
Path
datasetIdstringrequired

Unique ID of the dataset to update

Example: 123
Bodyapplication/jsonrequired

Updated dataset data

idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

curl -i -X PUT \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets/123 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "userId": "string",
    "sourceUrl": "string",
    "sourceType": "string",
    "filePath": "string",
    "fileFormat": "string",
    "fileSize": 0,
    "schema": "string",
    "metadata": "string",
    "enabled": true,
    "fieldIds": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "storagePath": "string",
    "format": "string",
    "datasetType": "string",
    "trinoSchema": "string"
  }'

Responses

Dataset updated successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

userIdstring

Userid

sourceUrlstring

Sourceurl

sourceTypestring

Sourcetype

filePathstring

Filepath

fileFormatstring

Fileformat

fileSizeinteger(int64)

Filesize

schemastring

Schema

metadatastring

Metadata

enabledboolean

Enabled

fieldIdsArray of strings

Fieldids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

storagePathstring

Storagepath

formatstring

Format

datasetTypestring

Datasettype

trinoSchemastring

Trinoschema

Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "userId": "string",
  "sourceUrl": "string",
  "sourceType": "string",
  "filePath": "string",
  "fileFormat": "string",
  "fileSize": 0,
  "schema": "string",
  "metadata": "string",
  "enabled": true,
  "fieldIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "storagePath": "string",
  "format": "string",
  "datasetType": "string",
  "trinoSchema": "string"
}

Delete a dataset

Request

Deletes a dataset from the system.

Warning: This operation is irreversible. Jobs that use this dataset as input or output may not work correctly.

Security
ApiKeyAuth
Path
datasetIdstringrequired

Unique ID of the dataset to delete

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

Responses

Dataset deleted successfully

Bodyapplication/json
object
Response
application/json
{}

Executes an SQL query on a dataset

Request

Executes an SQL query (Presto/Trino) on a dataset to retrieve or analyze the data.

The query is executed on the MinIO catalog and can use all SQL features supported by Trino.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Query SQL da eseguire

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 \
  -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 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
{}

Get columns of a table

Request

Returns the list of columns and their types of a table in the Trino catalog.

Security
ApiKeyAuth
Query
catalogstring

Catalog name (default: minio)

Default "minio"
Example: catalog=minio
schemastring

Schema name (default: default)

Default "default"
Example: schema=default
tablestringrequired

Table name

Example: table=my_table
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets/query/columns?catalog=minio&schema=default&table=my_table' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of columns

Bodyapplication/jsonArray [
namestring
typestring
]
Response
application/json
[
  {
    "name": "string",
    "type": "string"
  }
]

List all available tables

Request

Returns the list of all tables available in a specific catalog and schema.

Security
ApiKeyAuth
Query
catalogstring

Catalog name (default: minio)

Default "minio"
Example: catalog=minio
schemastring

Schema name (default: default)

Default "default"
Example: schema=default
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/datasets/query/tables?catalog=minio&schema=default' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of tables

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

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": [
    {}
  ]
}

Agents

Operations

Categories

Operations

Test

Operations

Cloud Credentials

Operations

Tasks

Operations

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