Skip to main content

Quickstart

This Quickstart guide shows you how to get started with Weaviate Cloud Services (WCS).

Create a WCS account

  1. Go the WCS homepage.
  2. Click, "Register here".

Create an account

  1. Provide an email address and password.
  2. After you confirm your email address, return to the login page.
  3. Log in to the WCS console.

Create a Weaviate Cluster

When you log into the WCS web console, the Dashboard tab lists your clusters. There are no clusters when you log in to a new account. WCS has short-term, sandbox clusters and permanent, managed clusters.

To create a cluster, click the 'Create cluster' button on the WCS Dashboard page.

Create a cluster

Follow the steps to create a cluster:

Sandbox clusters

To create a sandbox cluster, follow these steps:

  1. Select the "Free sandbox" tab.
  2. Give your cluster a name. WCS adds a random suffix to sandbox cluster names to ensure uniqueness.
  3. Verify that "Enable Authentication?" is set to "Yes".
  4. Click create.

It takes a minute or two to create the new cluster. When the cluster is ready, WCS displays a check mark (✔️) next to the cluster name.

Sandbox expiration

The sandbox is free for 14 days. After 14 days, the sandbox expires and all data is deleted.

To retrieve a copy of your sandbox data before it is deleted, use the cursor API.

To preserve your data and upgrade to a paid instance, contact us for help.

Managed clusters

Managed clusters require billing details. WCS prompts you to add billing details if you have not already added them.

To create a managed cluster, follow these steps:

  1. Select the "Managed cluster" tab.
  2. Give your cluster a name.
  3. Select a region.
  4. Accept the terms and conditions.
  5. Click create.

It takes a minute or two to create the new cluster. When the cluster is ready, WCS displays a check mark (✔️) next to the cluster name.

Explore the Details panel

The Details panel lists cluster metrics, authorization details, and other useful information. To access your cluster, you need the cluster URL and authentication details.

To get the cluster URL and authentication details, follow these steps:

  1. Click the Details button to open the Details panel.

Details button

  1. To get the API keys, click the API keys button.

Details expanded

  1. Copy the API key for the Admin user to a safe place.

API key

  1. The cluster URL begins with the cluster name. Copy it to a safe place.

Cluster URL

Install a client library

The WCS console includes a query interface, but most most WCS interactions rely on a Weaviate client. Clients are available in several programming languages. Chose one that makes sense for your project.

To install a client, follow these steps for your language:

Add weaviate-client to your Python environment with pip.


Please use the v4 client with Weaviate 1.23.7 or higher.

pip install -U weaviate-client

Connect to your WCS instance

These code samples demonstrate how to connect use a Weaviate client to your WCS cluster.

To connect to your cluster, follow these steps for your language:

  1. Replace the endpoint URL and the API key with the values you got on the Details panel.
  2. Run the client code.
import weaviate
import os

with weaviate.connect_to_wcs(
cluster_url=os.getenv("WCS_DEMO_URL"), # Replace with your WCS URL
auth_credentials=weaviate.auth.AuthApiKey(os.getenv("WCS_DEMO_RO_KEY")) # Replace with your WCS key
) as client: # Use this context manager to ensure the connection is closed
print(client.is_ready())

If you are connected, the server returns True.

Next steps

  • If you just want to try Weaviate, continue with a sandbox cluster.
  • If you want to work with Weaviate or need a persistent cluster, enter your billing details so you can create managed clusters.
  • To learn how Weaviate can help you build your project, review the Weaviate documentation.

Support

For questions and support, try the following resources:

Weaviate also offers paid support services. If you have a contract with Weaviate, contact your sales representative for details.