Skip to main content

Query tool

The Weaviate Cloud (WCD) query tool is a browser-based GraphQL IDE. Use the query tool to work interactively with your Weaviate Cloud clusters.

GraphiQL is built into the query tool. GraphiQL provides many features that make GraphQL easier to use interactively:


  1. Syntax highlighting
  2. Intelligent type ahead
  3. Automatic completion for queries and variables
  4. Real-time error highlighting and reporting for queries and variables
Query tool in Weaviate Cloud
Query tool in Weaviate Cloud.

Open the query tool​

To open the query tool for a cluster:

  1. Open the Weaviate Cloud console.
  2. Click on the Query button and choose a cluster from the list.
Query tool in Weaviate Cloud
Query tool in Weaviate Cloud.

Query tool console​

The query tool has the following components:

  1. An editor for writing GraphQL queries (1).
  2. A button for executing the query (2).
  3. A panel containing the response (3).
  4. A panel for passing variables and headers (4).
Query tool in Weaviate Cloud
Query tool in Weaviate Cloud.

Authentication​

The query tool connects to Weaviate Cloud sandboxes and serverless clusters without any additional authentication details.

Pass inference keys​

To pass API keys for inference modules, use request headers. The Headers tab is at the bottom of the query screen. Add the service inference key to the query headers.

In this example, the X-OpenAI-Api-Key header sets the OpenAI API key. The header can also pass multiple keys.

More resources​

Support​

For help with Serverless Cloud, Enterprise Cloud, and Bring Your Own Cloud accounts, contact Weaviate support directly to open a support ticket.

For questions and support from the Weaviate community, try these resources:

To add a support plan, contact Weaviate sales.