Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weaviate graphql API

The graphql API from Weaviate — 2 operation(s) for graphql.

Weaviate graphql API is one of 22 APIs that Weaviate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include graphql. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.38.0-dev.

Requests are made against a single base URL, http://localhost:8080.

2 operations 2 paths 7 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.38.0-dev
Server
http://localhost:8080
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Weaviate graphql API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication
  • BearerAuth — OIDC/JWT bearer authentication

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

graphql 2
POST
/graphql
Weaviate Perform A GraphQL Query
graphql.post body → 200401403422500
POST
/graphql/batch
Weaviate Perform Batched GraphQL Queries
graphql.batch body → 200401403422500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GraphQLQuery (3 properties), GraphQLError (3 properties), GraphQLResponse (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

JsonObject
object
JSON object value.
GraphQLError
object
An error response caused by a GraphQL query.
3 properties
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
GraphQLQueries
array
A list of GraphQL queries.
GraphQLResponse
object
GraphQL based response: http://facebook.github.io/graphql/.
2 properties
GraphQLResponses
array
A list of GraphQL responses.
GraphQLQuery
object
GraphQL query based on: http://facebook.github.io/graphql/.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-graphql-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
Weaviate backups API
Weaviate batch API
Weaviate classifications API
Weaviate cluster API
Weaviate discovery API
Weaviate distributedTasks API
Weaviate export API
Weaviate mcp API
Weaviate meta API
Weaviate namespaces API
Weaviate nodes API