# Bigml

BigML is a comprehensive machine learning platform that simplifies the creation and deployment of predictive models through an intuitive web interface and a REST API.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 45
- **Triggers:** 0
- **Slug:** `BIGML`
- **Version:** 20260227_00

## Tools

### Create External Connector

**Slug:** `BIGML_CREATE_EXTERNAL_CONNECTOR`

Tool to create a new external connector for data sources. Use after configuring external databases or search indices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User-defined name for the external connector. |
| `source` | string ("postgresql" | "mysql" | "sqlserver" | "elasticsearch") | No | Type of the external data source. Allowed: 'postgresql','mysql','sqlserver','elasticsearch'. Defaults to 'postgresql'. |
| `project` | string | Yes | Project ID in format 'project/XXXXXXXXXXXXXXXXXXXXXXXX'. Required to associate the connector with a project. |
| `connection` | string | Yes | Connection details object for the chosen source type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `BIGML_CREATE_PROJECT`

Tool to create a new project. Use when you need to group related BigML resources into a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the new project. Defaults to server-generated name. |
| `tags` | array | No | List of tags to classify the project. |
| `webhook` | object | No | Configuration for project webhooks. |
| `category` | integer | No | Category code for project domain (see BigML category codes). |
| `description` | string | No | Description of the project up to 8192 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `BIGML_DELETE_PROJECT`

Tool to delete an existing project. Use when you need to permanently remove a project resource after confirming it is not in use by other resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID suffix to delete, e.g., '5e4f30a81b3a1270d20000b5'. Do not include the 'project/' prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Configuration

**Slug:** `BIGML_GET_CONFIGURATION`

Retrieves complete details of a BigML configuration by its ID to get stored parameters. Configuration resources in BigML store parameters that can be reused across different resources. Use this action to inspect stored configuration parameters, verify configuration settings, check processing status, or retrieve metadata after creating a configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The resource identifier of the configuration to retrieve, in the format 'configuration/XXXXXXXXXXXXXXXXXXXXXXXX' where X is a 24-character hexadecimal ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get External Connector

**Slug:** `BIGML_GET_EXTERNAL_CONNECTOR`

Retrieves complete details of a BigML external connector by its ID. External connectors enable BigML to import data from external databases (PostgreSQL, MySQL, SQL Server) or search engines (Elasticsearch). Use this action to inspect connection parameters, verify connector configuration, check processing status, or retrieve metadata after creating an external connector.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The resource identifier of the external connector to retrieve, in the format 'externalconnector/XXXXXXXXXXXXXXXXXXXXXXXX' where X is a 24-character hexadecimal ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `BIGML_GET_PROJECT`

Tool to retrieve details of a project by ID. Use when you need to inspect project metadata before analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The resource identifier of the project to retrieve, in the format 'project/XXXXXXXXXXXXXXXXXXXXXXXX'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Source

**Slug:** `BIGML_GET_SOURCE`

Retrieves complete details of a BigML source by its ID. Use this to get information about the raw data and its parsing configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_id` | string | Yes | The resource identifier of the source to retrieve, in the format 'source/XXXXXXXXXXXXXXXXXXXXXXXX' where X is a 24-character hexadecimal ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Anomaly Detectors

**Slug:** `BIGML_LIST_ANOMALIES`

Tool to list anomaly detector resources in your account. Use when you need to browse or paginate existing anomaly detectors with support for filtering, ordering, and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of anomaly detectors to return. |
| `offset` | integer | No | Zero-based index of the first anomaly detector to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Anomaly Scores

**Slug:** `BIGML_LIST_ANOMALY_SCORES`

Tool to list anomaly score resources. Use when you need to browse or paginate existing anomaly scores for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of anomaly scores to return. |
| `offset` | integer | No | Zero-based index of the first anomaly score to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Associations

**Slug:** `BIGML_LIST_ASSOCIATIONS`

Tool to list association resources. Use when you need to browse or paginate existing associations for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of associations to return. |
| `offset` | integer | No | Zero-based index of the first association to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Association Sets

**Slug:** `BIGML_LIST_ASSOCIATION_SETS`

Tool to list association set resources in your account. Use when you need to browse or paginate existing association sets with support for filtering, ordering, and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of association sets to return. |
| `offset` | integer | No | Zero-based index of the first association set to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Anomaly Scores

**Slug:** `BIGML_LIST_BATCH_ANOMALY_SCORES`

Tool to list batch anomaly score resources. Use when you need to browse or paginate existing batch anomaly scores for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of batch anomaly scores to return. |
| `offset` | integer | No | Zero-based index of the first batch anomaly score to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Centroids

**Slug:** `BIGML_LIST_BATCH_CENTROIDS`

Tool to list all batch centroid resources in your account with support for filtering, ordering, and pagination. Use when you need to browse or retrieve existing batch centroids for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of batch centroids to return (default: 20). |
| `offset` | integer | No | Zero-based index of the first batch centroid to return for pagination (default: 0). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Predictions

**Slug:** `BIGML_LIST_BATCH_PREDICTIONS`

Tool to list batch prediction resources. Use when you need to browse or paginate existing batch predictions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of batch predictions to return. |
| `offset` | integer | No | Zero-based index of the first batch prediction to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Projections

**Slug:** `BIGML_LIST_BATCH_PROJECTIONS`

Tool to list batch projection resources with support for filtering, ordering, and pagination. Use when you need to browse or retrieve batch projections for the authenticated account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of batch projections to return. Default is 20. Use -1 to return all. |
| `offset` | integer | No | Position from the first entry to start returning resources. Default is 0. |
| `order_by` | string | No | Field name to sort results by (e.g., 'name', 'created'). Prefix with '-' for descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Topic Distributions

**Slug:** `BIGML_LIST_BATCH_TOPIC_DISTRIBUTIONS`

Tool to list batch topic distribution resources. Use when you need to browse or paginate existing batch topic distributions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of batch topic distributions to return. |
| `offset` | integer | No | Zero-based index of the first batch topic distribution to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Centroids

**Slug:** `BIGML_LIST_CENTROIDS`

Tool to list centroid resources. Use when you need to browse or paginate existing centroids for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of centroids to return. |
| `offset` | integer | No | Zero-based index of the first centroid to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Clusters

**Slug:** `BIGML_LIST_CLUSTERS`

Tool to list cluster resources with support for filtering, ordering, and pagination. Use when you need to browse or paginate existing clusters for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of clusters to return. |
| `offset` | integer | No | Zero-based index of the first cluster to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Composites

**Slug:** `BIGML_LIST_COMPOSITES`

Tool to list composite source resources. Use when you need to browse or paginate existing composites for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of composites to return. |
| `offset` | integer | No | Zero-based index of the first composite to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Configurations

**Slug:** `BIGML_LIST_CONFIGURATIONS`

Tool to list all configuration resources in your account. Use when you need to browse or paginate existing configurations with support for filtering, ordering, and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of configurations to return. |
| `offset` | integer | No | Zero-based index of the first configuration to return. |
| `order_by` | string | No | Field to order by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Correlations

**Slug:** `BIGML_LIST_CORRELATIONS`

Tool to list correlation resources. Use when you need to browse or paginate existing correlations for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of correlations to return. |
| `offset` | integer | No | Zero-based index of the first correlation to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets

**Slug:** `BIGML_LIST_DATASETS`

Tool to list dataset resources. Use when you need to browse or paginate existing datasets for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of datasets to return. |
| `offset` | integer | No | Zero-based index of the first dataset to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deepnets

**Slug:** `BIGML_LIST_DEEPNETS`

Tool to list deep neural network resources. Use when you need to browse or paginate existing deepnets for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of deepnets to return. Default is 20. |
| `offset` | integer | No | Number of deepnets to skip for pagination. Default is 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ensembles

**Slug:** `BIGML_LIST_ENSEMBLES`

Tool to list ensemble resources with filtering, ordering, and pagination support. Use when you need to browse or paginate existing ensembles for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of ensembles to return. |
| `offset` | integer | No | Zero-based index of the first ensemble to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Evaluations

**Slug:** `BIGML_LIST_EVALUATIONS`

Tool to list evaluation resources. Use when you need to browse or paginate existing evaluations for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `full` | boolean | No | If true, return full evaluation objects with all details; if false or omitted, return abbreviated objects. |
| `limit` | integer | No | Maximum number of evaluations to return. |
| `offset` | integer | No | Zero-based index of the first evaluation to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |
| `tags__in` | string | No | Filter evaluations by tag. Only evaluations with this tag will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Executions

**Slug:** `BIGML_LIST_EXECUTIONS`

Tool to list execution resources. Use when you need to browse or paginate existing executions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of executions to return. |
| `offset` | integer | No | Zero-based index of the first execution to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Forecasts

**Slug:** `BIGML_LIST_FORECASTS`

Tool to list forecast resources. Use when you need to browse or paginate existing forecasts for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of forecasts to return. |
| `offset` | integer | No | Zero-based index of the first forecast to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fusions

**Slug:** `BIGML_LIST_FUSIONS`

Tool to list fusion resources. Use when you need to browse or paginate existing fusions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of fusions to return. |
| `offset` | integer | No | Zero-based index of the first fusion to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Libraries

**Slug:** `BIGML_LIST_LIBRARIES`

Tool to list WhizzML library resources. Use when you need to browse or paginate existing libraries for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of libraries to return. |
| `offset` | integer | No | Zero-based index of the first library to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Linear Regressions

**Slug:** `BIGML_LIST_LINEAR_REGRESSIONS`

Tool to list linear regression resources. Use when you need to browse or paginate existing linear regressions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of linear regressions to return. |
| `offset` | integer | No | Zero-based index of the first linear regression to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Logistic Regressions

**Slug:** `BIGML_LIST_LOGISTIC_REGRESSIONS`

Tool to list logistic regression resources. Use when you need to browse or paginate existing logistic regressions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of logistic regressions to return. |
| `offset` | integer | No | Zero-based index of the first logistic regression to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Models

**Slug:** `BIGML_LIST_MODELS`

Tool to list model resources. Use when you need to browse or paginate existing models for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of models to return. |
| `offset` | integer | No | Zero-based index of the first model to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List OptiMLs

**Slug:** `BIGML_LIST_OPTIMLS`

Tool to list OptiML resources in your account. Use when you need to browse or paginate existing OptiML models with support for filtering, ordering, and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of OptiMLs to return. |
| `offset` | integer | No | Zero-based index of the first OptiML to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List PCAs

**Slug:** `BIGML_LIST_PCAS`

Tool to list PCA resources. Use when you need to browse or paginate existing PCAs for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of PCAs to return. |
| `offset` | integer | No | Zero-based index of the first PCA to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Predictions

**Slug:** `BIGML_LIST_PREDICTIONS`

Tool to list prediction resources. Use when you need to browse or paginate existing predictions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of predictions to return. |
| `offset` | integer | No | Zero-based index of the first prediction to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projections

**Slug:** `BIGML_LIST_PROJECTIONS`

Tool to list projection resources with support for filtering, ordering, and pagination. Use when you need to browse or retrieve projections for the authenticated account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of projections to return. Default is 20. Use -1 to return all. |
| `offset` | integer | No | Position from the first entry to start returning resources. Default is 0. |
| `order_by` | string | No | Field name to sort results by (e.g., 'name', 'created'). Prefix with '-' for descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `BIGML_LIST_PROJECTS`

Tool to list all project resources in your account with support for filtering, ordering, and pagination. Use when you need to browse or paginate existing projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of projects to return. |
| `offset` | integer | No | Zero-based index of the first project to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |
| `tags__in` | string | No | Filter projects by tags. Provide a comma-separated list of tags to retrieve projects that have any of the specified tags. |
| `full_field` | boolean | No | If true, return all fields in the response. Use when projects have more than 1000 fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Samples

**Slug:** `BIGML_LIST_SAMPLES`

Tool to list sample resources. Use when you need to browse or paginate existing samples for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of samples to return. |
| `offset` | integer | No | Zero-based index of the first sample to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scripts

**Slug:** `BIGML_LIST_SCRIPTS`

Tool to list WhizzML script resources. Use when you need to browse or paginate existing scripts for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of scripts to return. |
| `offset` | integer | No | Zero-based index of the first script to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sources

**Slug:** `BIGML_LIST_SOURCES`

Tool to list source resources in your account. Use when you need to browse or paginate existing data sources with support for filtering, ordering, and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of sources to return. Use -1 to return all sources. |
| `offset` | integer | No | Zero-based index of the first source to return. |
| `order_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Statistical Tests

**Slug:** `BIGML_LIST_STATISTICAL_TESTS`

Tool to list statistical test resources. Use when you need to browse or paginate existing statistical tests for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of statistical tests to return. |
| `offset` | integer | No | Zero-based index of the first statistical test to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Time Series

**Slug:** `BIGML_LIST_TIMESERIES`

Tool to list time series resources. Use when you need to browse or paginate existing time series for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of time series to return. |
| `offset` | integer | No | Zero-based index of the first time series to return. |
| `order_by` | string | No | Field to order by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Topic Distributions

**Slug:** `BIGML_LIST_TOPIC_DISTRIBUTIONS`

Tool to list topic distribution resources. Use when you need to browse or paginate existing topic distributions for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of topic distributions to return. |
| `offset` | integer | No | Zero-based index of the first topic distribution to return. |
| `sort_by` | string | No | Field to sort by; prefix with '-' for descending order, e.g., '-created', 'name', or 'resource'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Topic Models

**Slug:** `BIGML_LIST_TOPIC_MODELS`

Tool to list topic model resources. Use when you need to browse or paginate existing topic models for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `full` | boolean | No | Return full resource details instead of summary (default: false). |
| `limit` | integer | No | Maximum number of topic models to return (default: 20). |
| `offset` | integer | No | Number of topic models to skip for pagination (default: 0). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Source

**Slug:** `BIGML_UPDATE_SOURCE`

Tool to update a source's name, description, tags, or parsing configuration. Use when you need to modify source metadata or field properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the source. |
| `tags` | array | No | List of tags to classify the source. |
| `fields` | object | No | Dictionary of field configurations to update, keyed by field ID (e.g., '000001'). Each field can specify properties like 'optype' (categorical, numeric, text, etc.) or 'preferred' (whether the field should be used in modeling). |
| `source_id` | string | Yes | The resource identifier of the source to update, in the format 'source/XXXXXXXXXXXXXXXXXXXXXXXX' where X is a 24-character hexadecimal ID. |
| `description` | string | No | New description for the source (up to 8192 characters). |
| `source_parser` | object | No | Parsing configuration to update how the raw data is interpreted. Can include properties like 'locale' (e.g., 'es-ES'), 'missing_tokens', 'separator', 'quote', etc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |