Skip to main content
Bigml logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 45
  • Triggers: 0
  • Slug: BIGML
  • Version: 20261101_00

Tools

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

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_CREATE_PROJECTTool to create a new project. Use when you need to group related BigML resources into a project.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_DELETE_PROJECTTool 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

string
required
Project ID suffix to delete, e.g., ‘5e4f30a81b3a1270d20000b5’. Do not include the ‘project/’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_GET_CONFIGURATIONRetrieves 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

string
required
The resource identifier of the configuration to retrieve, in the format ‘configuration/XXXXXXXXXXXXXXXXXXXXXXXX’ where X is a 24-character hexadecimal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_GET_EXTERNAL_CONNECTORRetrieves 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

string
required
The resource identifier of the external connector to retrieve, in the format ‘externalconnector/XXXXXXXXXXXXXXXXXXXXXXXX’ where X is a 24-character hexadecimal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_GET_PROJECTTool to retrieve details of a project by ID. Use when you need to inspect project metadata before analysis.

Input Parameters

string
required
The resource identifier of the project to retrieve, in the format ‘project/XXXXXXXXXXXXXXXXXXXXXXXX’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_GET_SOURCERetrieves complete details of a BigML source by its ID. Use this to get information about the raw data and its parsing configuration.

Input Parameters

string
required
The resource identifier of the source to retrieve, in the format ‘source/XXXXXXXXXXXXXXXXXXXXXXXX’ where X is a 24-character hexadecimal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_ANOMALIESLists anomaly detector resources in your account, with ordering and pagination.

Input Parameters

integer
Maximum number of anomaly detectors to return.
integer
Zero-based index of the first anomaly detector to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_ANOMALY_SCORESTool to list anomaly score resources. Use when you need to browse or paginate existing anomaly scores for the authenticated user.

Input Parameters

integer
Maximum number of anomaly scores to return.
integer
Zero-based index of the first anomaly score to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_ASSOCIATIONSTool to list association resources. Use when you need to browse or paginate existing associations for the authenticated user.

Input Parameters

integer
Maximum number of associations to return.
integer
Zero-based index of the first association to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_ASSOCIATION_SETSLists association set resources in your account, with ordering and pagination.

Input Parameters

integer
Maximum number of association sets to return.
integer
Zero-based index of the first association set to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_BATCH_ANOMALY_SCORESTool to list batch anomaly score resources. Use when you need to browse or paginate existing batch anomaly scores for the authenticated user.

Input Parameters

integer
Maximum number of batch anomaly scores to return.
integer
Zero-based index of the first batch anomaly score to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_BATCH_CENTROIDSList batch centroid resources for the authenticated BigML account. Use limit and offset to browse results by page.

Input Parameters

integer
Maximum number of batch centroids to return (default: 20).
integer
Zero-based index of the first batch centroid to return for pagination (default: 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_BATCH_PREDICTIONSTool to list batch prediction resources. Use when you need to browse or paginate existing batch predictions for the authenticated user.

Input Parameters

integer
Maximum number of batch predictions to return.
integer
Zero-based index of the first batch prediction to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_BATCH_PROJECTIONSLists batch projection resources for the authenticated account, with ordering and pagination.

Input Parameters

integer
Maximum number of batch projections to return. Default is 20. Use -1 to return all.
integer
Position from the first entry to start returning resources. Default is 0.
string
Field name to sort results by (e.g., ‘name’, ‘created’). Prefix with ’-’ for descending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_BATCH_TOPIC_DISTRIBUTIONSTool to list batch topic distribution resources. Use when you need to browse or paginate existing batch topic distributions for the authenticated user.

Input Parameters

integer
Maximum number of batch topic distributions to return.
integer
Zero-based index of the first batch topic distribution to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_CENTROIDSTool to list centroid resources. Use when you need to browse or paginate existing centroids for the authenticated user.

Input Parameters

integer
Maximum number of centroids to return.
integer
Zero-based index of the first centroid to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_CLUSTERSList cluster resources for the authenticated BigML account. Browse results using limit and offset, with optional ordering by field.

Input Parameters

integer
Maximum number of clusters to return.
integer
Zero-based index of the first cluster to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_COMPOSITESTool to list composite source resources. Use when you need to browse or paginate existing composites for the authenticated user.

Input Parameters

integer
Maximum number of composites to return.
integer
Zero-based index of the first composite to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_CONFIGURATIONSLists configuration resources in your account, with ordering and pagination.

Input Parameters

integer
Maximum number of configurations to return.
integer
Zero-based index of the first configuration to return.
string
Field to order by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_CORRELATIONSTool to list correlation resources. Use when you need to browse or paginate existing correlations for the authenticated user.

Input Parameters

integer
Maximum number of correlations to return.
integer
Zero-based index of the first correlation to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_DATASETSTool to list dataset resources. Use when you need to browse or paginate existing datasets for the authenticated user.

Input Parameters

integer
Maximum number of datasets to return.
integer
Zero-based index of the first dataset to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_DEEPNETSTool to list deep neural network resources. Use when you need to browse or paginate existing deepnets for the authenticated user.

Input Parameters

integer
Maximum number of deepnets to return. Default is 20.
integer
Number of deepnets to skip for pagination. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_ENSEMBLESLists ensemble resources for the authenticated user, with ordering and pagination support.

Input Parameters

integer
Maximum number of ensembles to return.
integer
Zero-based index of the first ensemble to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_EVALUATIONSTool to list evaluation resources. Use when you need to browse or paginate existing evaluations for the authenticated user.

Input Parameters

boolean
If true, return full evaluation objects with all details; if false or omitted, return abbreviated objects.
integer
Maximum number of evaluations to return.
integer
Zero-based index of the first evaluation to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.
string
Filter evaluations by tag. Only evaluations with this tag will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_EXECUTIONSTool to list execution resources. Use when you need to browse or paginate existing executions for the authenticated user.

Input Parameters

integer
Maximum number of executions to return.
integer
Zero-based index of the first execution to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_FORECASTSTool to list forecast resources. Use when you need to browse or paginate existing forecasts for the authenticated user.

Input Parameters

integer
Maximum number of forecasts to return.
integer
Zero-based index of the first forecast to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_FUSIONSTool to list fusion resources. Use when you need to browse or paginate existing fusions for the authenticated user.

Input Parameters

integer
Maximum number of fusions to return.
integer
Zero-based index of the first fusion to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_LIBRARIESTool to list WhizzML library resources. Use when you need to browse or paginate existing libraries for the authenticated user.

Input Parameters

integer
Maximum number of libraries to return.
integer
Zero-based index of the first library to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_LINEAR_REGRESSIONSTool to list linear regression resources. Use when you need to browse or paginate existing linear regressions for the authenticated user.

Input Parameters

integer
Maximum number of linear regressions to return.
integer
Zero-based index of the first linear regression to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_LOGISTIC_REGRESSIONSTool to list logistic regression resources. Use when you need to browse or paginate existing logistic regressions for the authenticated user.

Input Parameters

integer
Maximum number of logistic regressions to return.
integer
Zero-based index of the first logistic regression to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_MODELSTool to list model resources. Use when you need to browse or paginate existing models for the authenticated user.

Input Parameters

integer
Maximum number of models to return.
integer
Zero-based index of the first model to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_OPTIMLSList OptiML resources in the authenticated BigML account. Browse results using limit and offset, with optional ordering by field.

Input Parameters

integer
Maximum number of OptiMLs to return.
integer
Zero-based index of the first OptiML to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_PCASTool to list PCA resources. Use when you need to browse or paginate existing PCAs for the authenticated user.

Input Parameters

integer
Maximum number of PCAs to return.
integer
Zero-based index of the first PCA to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_PREDICTIONSList prediction resources for the authenticated BigML account. Browse results using limit and offset, with an optional sort field.

Input Parameters

integer
Maximum number of predictions to return.
integer
Zero-based index of the first prediction to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_PROJECTIONSLists projection resources for the authenticated account, with ordering and pagination.

Input Parameters

integer
Maximum number of projections to return. Default is 20. Use -1 to return all.
integer
Position from the first entry to start returning resources. Default is 0.
string
Field name to sort results by (e.g., ‘name’, ‘created’). Prefix with ’-’ for descending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_PROJECTSTool 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

integer
Maximum number of projects to return.
integer
Zero-based index of the first project to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.
string
Filter projects by tags. Provide a comma-separated list of tags to retrieve projects that have any of the specified tags.
boolean
If true, return all fields in the response. Use when projects have more than 1000 fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_SAMPLESTool to list sample resources. Use when you need to browse or paginate existing samples for the authenticated user.

Input Parameters

integer
Maximum number of samples to return.
integer
Zero-based index of the first sample to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_SCRIPTSTool to list WhizzML script resources. Use when you need to browse or paginate existing scripts for the authenticated user.

Input Parameters

integer
Maximum number of scripts to return.
integer
Zero-based index of the first script to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_SOURCESLists source resources in your account with support for ordering and pagination.

Input Parameters

integer
Maximum number of sources to return. Use -1 to return all sources.
integer
Zero-based index of the first source to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_STATISTICAL_TESTSTool to list statistical test resources. Use when you need to browse or paginate existing statistical tests for the authenticated user.

Input Parameters

integer
Maximum number of statistical tests to return.
integer
Zero-based index of the first statistical test to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_TIMESERIESTool to list time series resources. Use when you need to browse or paginate existing time series for the authenticated user.

Input Parameters

integer
Maximum number of time series to return.
integer
Zero-based index of the first time series to return.
string
Field to order by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_TOPIC_DISTRIBUTIONSTool to list topic distribution resources. Use when you need to browse or paginate existing topic distributions for the authenticated user.

Input Parameters

integer
Maximum number of topic distributions to return.
integer
Zero-based index of the first topic distribution to return.
string
Field to sort by; prefix with ’-’ for descending order, e.g., ‘-created’, ‘name’, or ‘resource’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_LIST_TOPIC_MODELSTool to list topic model resources. Use when you need to browse or paginate existing topic models for the authenticated user.

Input Parameters

boolean
Return full resource details instead of summary (default: false).
integer
Maximum number of topic models to return (default: 20).
integer
Number of topic models to skip for pagination (default: 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGML_UPDATE_SOURCETool to update a source’s name, description, tags, or parsing configuration. Use when you need to modify source metadata or field properties.

Input Parameters

string
New name for the source.
array
List of tags to classify the source.
object
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).
string
required
The resource identifier of the source to update, in the format ‘source/XXXXXXXXXXXXXXXXXXXXXXXX’ where X is a 24-character hexadecimal ID.
string
New description for the source (up to 8192 characters).
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not