Skip to main content

Query app

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

WCD query app

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

  • Syntax highlighting
  • Intelligent type ahead
  • Automatic completion for queries and variables
  • Real-time error highlighting and reporting for queries and variables

Open the query app​

To open the query app, connect to your WCD WCD Dashboard.

In the left-hand menu, click the Query app icon.

WCD query app location

Select a Weaviate instance​

The query app connects directly to your WCD clusters. The query app can also connect to other Weaviate instances if you have the proper authorization credentials.

Connect to a WCD cluster​

In this example, the WCD Dashboard is connected to an external instance as well as the two WCD instances.

Connected instances

The GraphQL console can query any of the instances.

To select a cluster, click the Query button and chose a cluster from the list that appears.

Authentication​

The query app connects to WCD instances, sandboxes and serverless clusters, without any additional authentication details. The query app can also connect to external Weaviate instances if you have anonymous access enabled or authentication credentials.

Pass authentication details​

To pass authentication details for an external instance, use request headers.

Replace "replaceWithYourPassword" with the password for an authorized user.

{
  "Authorization": "Bearer replaceWithYourPassword"
}

Pass inference keys​

To pass API keys for inference modules, use request headers. The Header tab is at 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.

How to add an API inference key to a WCD console query

The header can pass multiple keys.

How to add multiple API inference keys to a WCD console query

More resources​

Support​

For help with Serverless, Enterprise SaaS, 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.