graphql

Perform a GraphQL query

Executes a single GraphQL query provided in the request body. Use this endpoint for all Weaviate data queries and exploration.

post/graphql

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/graphql
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Request body

operationNamestring

The name of the operation if multiple exist in the query.

querystring

Query based on GraphQL syntax.

variablesobject

Additional variables for the query.

Response

Query executed successfully. The response body contains the query result.

dataobject

GraphQL data object.

Changes

No recorded changes to this operation across all 1 revision of this API.