Skip to main content
Vectorshift logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: VECTORSHIFT
  • Version: 20261030_00

Tools

Slug: VECTORSHIFT_CREATE_CHATBOTTool to create a new chatbot. Chatbots are conversational AI interfaces built on pipelines. Use when you need to create a new chatbot with a specific pipeline configuration.

Input Parameters

string
Name of the chatbot (required by API, defaults to empty string)
string
Input configuration (required by API, defaults to empty string)
string
Output configuration (required by API, defaults to empty string)
boolean
required
Whether the chatbot is deployed. Must be explicitly set to true or false
object
required
Pipeline configuration object with ‘id’ and ‘version’ fields. The ‘id’ is the pipeline ID (can be obtained from LIST_PIPELINES endpoint), and ‘version’ is typically ‘latest’
string
Description of the chatbot (required by API, defaults to empty string)
object
Slack integration configuration (required by API, defaults to empty dict)
object
Access configuration (required by API, defaults to empty dict)
object
Twilio integration configuration (required by API, defaults to empty dict)
object
Deployment options configuration (required by API, defaults to empty dict)

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: VECTORSHIFT_DELETE_CHATBOTTool to delete a chatbot by its ID. Permanently removes the chatbot from the account. Use when you need to remove a chatbot that is no longer needed.

Input Parameters

string
required
The ID of the chatbot to delete. This is the unique identifier for the chatbot that was returned when the chatbot was created or listed.

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: VECTORSHIFT_GET_CHATBOTTool to fetch an existing chatbot by its ID or name. Returns chatbot configuration and metadata. Use when you need to retrieve details about a specific chatbot. Either chatbot ID or name must be provided.

Input Parameters

string
Chatbot identifier. Required if name is not provided.
string
Chatbot name. Required if id is not provided.
string
Organization identifier for name-based lookup. Optional parameter used when fetching by name.
string
User identifier for name-based lookup. Optional parameter used when fetching by name.

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: VECTORSHIFT_GET_KNOWLEDGE_BASETool to fetch an existing knowledge base by its ID or name. Returns knowledge base configuration and metadata. Use when you need to retrieve details about a specific knowledge base.

Input Parameters

string
Knowledge base identifier. Either id or name must be provided.
string
Name of the knowledge base. Either id or name must be provided.
string
Optional organization name for name-based search. Only valid when using name parameter.
string
Optional username for name-based search. Only valid when using name parameter.

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: VECTORSHIFT_GET_PIPELINETool to fetch an existing pipeline by its ID or name. Returns pipeline configuration and metadata. Use when you need to retrieve a specific pipeline’s details, configuration, or metadata.

Input Parameters

string
Pipeline identifier. Either id or name is required to fetch the pipeline.
string
Pipeline name. Either id or name is required to fetch the pipeline.
string
Organization name for name-based search. Used when searching by pipeline name.
string
Username for name-based search. Used when searching by pipeline name.

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: VECTORSHIFT_LIST_CHATBOTSTool to list all available chatbots in the account. Use when you need to retrieve chatbot IDs or full chatbot details.

Input Parameters

boolean
Include full chatbot objects in the response. When false, only object_ids are returned.
boolean
Include shared chatbots in the results.

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: VECTORSHIFT_LIST_PIPELINESTool to list all available pipelines in the VectorShift account. Use when you need to retrieve the catalog of pipelines. Supports filtering for shared pipelines and verbose output with full pipeline details.

Input Parameters

boolean
Include full pipeline objects in the response. When set to true, returns complete pipeline objects instead of just IDs.
boolean
Include shared pipelines in the results. When set to true, pipelines shared with the account will be included in the response.

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: VECTORSHIFT_LIST_TRANSFORMATIONSTool to list all available transformations in the account. Use when you need to retrieve transformation IDs or complete transformation objects.

Input Parameters

boolean
Returns complete transformation objects instead of just IDs. Defaults to false.
boolean
Incorporates shared transformations into results. Defaults to false.

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: VECTORSHIFT_RUN_PIPELINETool to run a VectorShift pipeline with the given inputs. Use when you need to execute a pipeline and get its results or run_id for asynchronous execution. Returns the pipeline execution status, run_id, and outputs if execution completed synchronously.

Input Parameters

string
required
The ID of the pipeline to run
object
Input values for the pipeline as key-value pairs. The keys should match the input names defined in your pipeline configuration.
string
Optional conversation ID for maintaining context across multiple pipeline runs

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: VECTORSHIFT_RUN_PIPELINE_BULKTool to run a VectorShift pipeline in bulk with multiple sets of inputs. Use when you need to batch process multiple pipeline executions in a single API call. Returns the overall status and an array of outputs with run_id for each execution.

Input Parameters

string
required
The ID of the pipeline to run in bulk
array
required
Array of run configurations, each containing inputs for one pipeline execution. Multiple runs will be processed in bulk.

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: VECTORSHIFT_TERMINATE_PIPELINETool to terminate a running pipeline execution. Use when you need to stop a pipeline run by its run_id.

Input Parameters

string
required
The ID of the pipeline whose run should be terminated.
string
required
The run ID to terminate.

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