Vectorize API

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 programatically. 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 Managing Access Tokens for Using the API and Retrieval Endpoint.

Notice: The Vectorize API is currently in Beta. Although we will attempt to prevent them, we may need to make breaking changes.