Getting started
Last updated
Was this helpful?
Last updated
Was this helpful?
📢 Note: The API is currently in Beta.
Vectorize provides an API for working with pipelines. Using the API, you can create, delete, schedule, start, and stop pipelines. You can also get details on pipeline events and metrics. The API provides an alternative retrieval endpoint for querying the vector index associated with your pipeline.
With the API, you can also create, update, and delete source connectors, API platforms, and vector DBs programmatically. If you create a file upload connnector—using the API or in the UI—you can also upload files to Vectorize to be used in your pipelines.
For authentication, you must create an API access token in the Vectorize UI. For details, see .
Notice: The Vectorize API is currently in Beta. Although we will attempt to prevent them, we may need to make breaking changes.
This Getting Started shows you how to install your client of choice and then make your first Vectorize API request.
Claim your .
Go to the platform to retrieve your organization ID. From the browser url extract the UUID after the organization/
path.
(e.g. for
https://platform.vectorize.io/organization/ecf3fa1d-30d0-4df1-8af6-f4852bc851cb
the organization ID isecf3fa1d-30d0-4df1-8af6-f4852bc851cb
).
Use the following code to list your pipelines:
Create a , perform Vector Search and more
Perform from unstructured Data using Vectorize Iris
Connect AI assistants using the
Looking for a full working Python example? You can open it on or download it from the
Looking for a full working Node.js example? You can find it on the
A complete reference for the Vectorize API can be found here: . This site includes tools for interactively testing API calls as well as generating code in various programming languages.