Skip to content
/
Get a category by name

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

Get all categories

Request

Returns the list of all categories available in the system.

Categories are used to organize projects, agents, and jobs.

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

Responses

List of categories

Bodyapplication/jsonArray [
idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon": "string",
    "visibility": "PUBLIC",
    "enabled": true,
    "agentIds": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Create a new category

Request

Creates a new category to organize projects, agents and jobs.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Category data to create

idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Responses

Category created successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Get a specific category

Request

Returns the details of a specific category, including the list of associated projects.

Security
ApiKeyAuth
Path
categoryIdstringrequired

Unique ID of the category

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

Responses

Category details

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Update a category

Request

Updates the data of an existing category.

Security
ApiKeyAuth
Path
categoryIdstringrequired

Unique ID of the category to update

Example: 1
Bodyapplication/jsonrequired

Updated category data

idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Responses

Category updated successfully

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Delete a category

Request

Deletes a category from the system.

Warning: This operation is irreversible. Associated projects will not be deleted.

Security
ApiKeyAuth
Path
categoryIdstringrequired

Unique ID of the category to delete

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

Responses

Category deleted successfully

Bodyapplication/json
object
Response
application/json
{}

Get a category by name

Request

Returns the details of a category searching by name.

Security
ApiKeyAuth
Path
categoryNamestringrequired

Category name

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

Responses

Category details

Bodyapplication/json
idstring

Id

namestring

Name

descriptionstring

Description

iconstring

Icon

visibilitystring

Visibility

Enum"PUBLIC""PRIVATE"
enabledboolean

Enabled

agentIdsArray of strings

Agentids

createdAtstring(date-time)

Createdat

updatedAtstring(date-time)

Updatedat

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

Test endpoint for categories

Request

Test endpoint to verify categories functionality.

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

Responses

Test completed successfully

Bodyapplication/json
object
Response
application/json
{}

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