# Vectorshift

The End-to-End AI Automations Platform for building and deploying AI workflows, pipelines, chatbots, and knowledge bases.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `VECTORSHIFT`
- **Version:** 20260312_00

## Tools

### Create Chatbot

**Slug:** `VECTORSHIFT_CREATE_CHATBOT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the chatbot (required by API, defaults to empty string) |
| `input` | string | No | Input configuration (required by API, defaults to empty string) |
| `output` | string | No | Output configuration (required by API, defaults to empty string) |
| `deployed` | boolean | Yes | Whether the chatbot is deployed. Must be explicitly set to true or false |
| `pipeline` | object | Yes | 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' |
| `description` | string | No | Description of the chatbot (required by API, defaults to empty string) |
| `slack_config` | object | No | Slack integration configuration (required by API, defaults to empty dict) |
| `access_config` | object | No | Access configuration (required by API, defaults to empty dict) |
| `twilio_config` | object | No | Twilio integration configuration (required by API, defaults to empty dict) |
| `deployment_options` | object | No | Deployment options configuration (required by API, defaults to empty dict) |

#### 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 Chatbot

**Slug:** `VECTORSHIFT_DELETE_CHATBOT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| 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 Chatbot

**Slug:** `VECTORSHIFT_GET_CHATBOT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Chatbot identifier. Required if name is not provided. |
| `name` | string | No | Chatbot name. Required if id is not provided. |
| `org_name` | string | No | Organization identifier for name-based lookup. Optional parameter used when fetching by name. |
| `username` | string | No | User identifier for name-based lookup. Optional parameter used when fetching by name. |

#### 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 Knowledge Base

**Slug:** `VECTORSHIFT_GET_KNOWLEDGE_BASE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Knowledge base identifier. Either id or name must be provided. |
| `name` | string | No | Name of the knowledge base. Either id or name must be provided. |
| `org_name` | string | No | Optional organization name for name-based search. Only valid when using name parameter. |
| `username` | string | No | Optional username for name-based search. Only valid when using name parameter. |

#### 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 Pipeline

**Slug:** `VECTORSHIFT_GET_PIPELINE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Pipeline identifier. Either id or name is required to fetch the pipeline. |
| `name` | string | No | Pipeline name. Either id or name is required to fetch the pipeline. |
| `org_name` | string | No | Organization name for name-based search. Used when searching by pipeline name. |
| `username` | string | No | Username for name-based search. Used when searching by pipeline name. |

#### 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 Chatbots

**Slug:** `VECTORSHIFT_LIST_CHATBOTS`

Tool to list all available chatbots in the account. Use when you need to retrieve chatbot IDs or full chatbot details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `verbose` | boolean | No | Include full chatbot objects in the response. When false, only object_ids are returned. |
| `include_shared` | boolean | No | Include shared chatbots in the results. |

#### 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 Pipelines

**Slug:** `VECTORSHIFT_LIST_PIPELINES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `verbose` | boolean | No | Include full pipeline objects in the response. When set to true, returns complete pipeline objects instead of just IDs. |
| `include_shared` | boolean | No | Include shared pipelines in the results. When set to true, pipelines shared with the account will be included in the response. |

#### 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 Transformations

**Slug:** `VECTORSHIFT_LIST_TRANSFORMATIONS`

Tool to list all available transformations in the account. Use when you need to retrieve transformation IDs or complete transformation objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `verbose` | boolean | No | Returns complete transformation objects instead of just IDs. Defaults to false. |
| `include_shared` | boolean | No | Incorporates shared transformations into results. Defaults to false. |

#### 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 |

### Run Pipeline

**Slug:** `VECTORSHIFT_RUN_PIPELINE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the pipeline to run |
| `inputs` | object | No | Input values for the pipeline as key-value pairs. The keys should match the input names defined in your pipeline configuration. |
| `conversation_id` | string | No | Optional conversation ID for maintaining context across multiple pipeline runs |

#### 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 |

### Run Pipeline in Bulk

**Slug:** `VECTORSHIFT_RUN_PIPELINE_BULK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the pipeline to run in bulk |
| `runs` | array | Yes | Array of run configurations, each containing inputs for one pipeline execution. Multiple runs will be processed in bulk. |

#### 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 |

### Terminate Pipeline Execution

**Slug:** `VECTORSHIFT_TERMINATE_PIPELINE`

Tool to terminate a running pipeline execution. Use when you need to stop a pipeline run by its run_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the pipeline whose run should be terminated. |
| `run_id` | string | Yes | The run ID to terminate. |

#### 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 |