Usage
Guide on using Vectorshift APIs.
Currently, we have two types of APIs you can use to integrate with your app: Chatbot and Pipelines. Before using the API, you need to create your API Key. Visit Access for more details.
API calls are rate-limited to 250/minute for non-Enterprise subscriptions.
Chatbot
To generate a chatbot API call, you can go to Chatbot
-> Export
-> API
. Here's an example of a generated API call for a Basic Chatbot.
Request
Body Parameters | Description |
---|---|
| The messsage you want to pass to the chatbot |
| Name of your chatbot |
| Your username |
| The identifier of the conversation.
|
Response
Pipelines
To generate a pipeline API call, you can go to Pipeline
-> Click on the 3 vertical dots -> Generate API Calls
. Here's an example of a generated API call for the pipeline "Titan-Express AWS"
.
The generated API calls might differ for each pipeline depending on which pipeline you choose.
Body Parameters | Description |
---|---|
| Input object based on your pipeline input name and format. The number of inputs and the key name depend on how the pipeline is designed. In this example, the pipeline only has one key |
| The name of your pipeline. |
| The username of pipeline creator. |
Response
Last updated