Skip to content
/
Estimate the cost of a tr...

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

Get training service information

Request

Returns information about the AI/ML training service, including versions and configurations.

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

Responses

Training service information

Bodyapplication/json
object
Response
application/json
{}

Training service health check

Request

Checks the health status of the AI/ML training service.

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

Responses

Training service operational

Bodyapplication/json
statusstring
Example: "UP"
Response
application/json
{
  "status": "UP"
}

Cancel an AI training job

Request

Cancels an AI training job that is running or queued for the specified provider.

Warning: This operation is irreversible and interrupts training if in progress.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name (e.g. "huggingface", "openai", "cohere")

Example: huggingface
jobIdstringrequired

ID of the training job to cancel

Example: job-12345
curl -i -X DELETE \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/training/job-12345 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Job cancelled successfully

Bodyapplication/json
object
Response
application/json
{}

Download a trained model

Request

Downloads a trained AI model from the specified provider.

The model is downloaded to the specified path or the default path.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
jobIdstringrequired

Training job ID

Example: job-12345
Query
outputPathstring

Destination path for download (optional)

Example: outputPath=/path/to/models
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/training/job-12345/download?outputPath=%2Fpath%2Fto%2Fmodels' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Model downloaded successfully

Bodyapplication/json
object
Response
application/json
{}

Estimate the cost of a training job

Request

Calculates a cost estimate for an AI training job based on the specified parameters.

The estimate includes compute, storage and other necessary service costs.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
Bodyapplication/jsonrequired

Training job parameters for estimation

modelstring

Model

trainingFilestring

Trainingfile

validationFilestring

Validationfile

datasetIdstring

Datasetid

hyperparametersobject

Hyperparameters

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/cost-estimate \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "model": "string",
    "trainingFile": "string",
    "validationFile": "string",
    "datasetId": "string",
    "hyperparameters": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Calculated cost estimate

Bodyapplication/json
estimatedCostnumber(float)

Costo stimato in USD

currencystring
Example: "USD"
Response
application/json
{
  "estimatedCost": 0.1,
  "currency": "USD"
}

Get logs of a training job

Request

Returns the execution logs of an AI training job.

The logs include information on progress, errors, and training metrics.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
jobIdstringrequired

Training job ID

Example: job-12345
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/training/job-12345/logs \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Training job logs

Bodyapplication/json
logsArray of strings
Response
application/json
{
  "logs": [
    "string"
  ]
}

Get status of a training job

Request

Returns the current status of an AI training job, including information on progress, duration and any errors.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
jobIdstringrequired

Training job ID

Example: job-12345
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/training/job-12345/status \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Training job status

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

Percentuale di completamento (0-100)

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

Start a new AI training job

Request

Starts a new job of training for an AI model using the provider specified.

The job is executed in the background and can be monitored through the status and logs endpoints.

Security
ApiKeyAuth
Path
providerstringrequired

AI provider name

Example: huggingface
Bodyapplication/jsonrequired

Training job configuration

modelstring

Model

trainingFilestring

Trainingfile

validationFilestring

Validationfile

datasetIdstring

Datasetid

hyperparametersobject

Hyperparameters

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/ai-providers/providers/huggingface/training \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "model": "string",
    "trainingFile": "string",
    "validationFile": "string",
    "datasetId": "string",
    "hyperparameters": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Training job started successfully

Bodyapplication/json
jobIdstring

Created training job ID

Response
application/json
{
  "jobId": "string"
}

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

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