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 .well Known API

The .well Known API from Weaviate — 3 operation(s) for .well known.

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

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

This API exposes 3 operations across 3 paths, and defines 1 schema. 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.

3 operations 3 paths 1 schemas 3 GET

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 .well Known 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 3

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

.well Known 3
GET
/.well-known/live
Weaviate Check Application Liveness
weaviate.wellknown.liveness → 200
GET
/.well-known/ready
Weaviate Check Application Readiness
weaviate.wellknown.readiness → 200503
GET
/.well-known/openid-configuration
Weaviate Get OIDC Configuration
→ 200404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-well-known-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 graphql API
Weaviate mcp API
Weaviate meta API
Weaviate namespaces API