Weaviate

Weaviate .well Known API

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

Documentation GitHub OpenAPI

Operations 3

GET /.well-known/live Weaviate Check Application Liveness #

GET /.well-known/ready Weaviate Check Application Readiness #

GET /.well-known/openid-configuration Weaviate Get OIDC Configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/weaviate-well-known-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Weaviate REST .well Known API
  description: '# Introduction

    Weaviate is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications.'
  version: 1.38.0-dev
servers:
- url: http://localhost:8080
  description: Local Weaviate instance
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: .well Known
paths:
  /.well-known/live:
    get:
      summary: Weaviate Check Application Liveness
      description: Indicates if the Weaviate instance is running and responsive to basic HTTP requests. Primarily used for health checks, such as Kubernetes liveness probes.
      operationId: weaviate.wellknown.liveness
      responses:
        '200':
          description: The application is alive and responding to HTTP requests.
      x-microcks-operation:
        delay: 100
      tags:
      - .well Known
  /.well-known/ready:
    get:
      summary: Weaviate Check Application Readiness
      description: Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.). Used for readiness checks, such as Kubernetes readiness probes.
      operationId: weaviate.wellknown.readiness
      responses:
        '200':
          description: The application is ready to serve traffic.
        '503':
          description: The application is not ready to serve traffic. Traffic should be directed to other available replicas if applicable.
      x-microcks-operation:
        delay: 100
      tags:
      - .well Known
  /.well-known/openid-configuration:
    get:
      summary: Weaviate Get OIDC Configuration
      description: Provides OpenID Connect (OIDC) discovery information if OIDC authentication is configured for Weaviate. Returns details like the token issuer URL, client ID, and required scopes.
      tags:
      - .well Known
      responses:
        '200':
          description: OIDC configuration details returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  href:
                    type: string
                    description: The OIDC issuer URL to redirect to for authentication.
                  clientId:
                    type: string
                    description: The OAuth Client ID configured for Weaviate.
                  scopes:
                    type: array
                    description: The required OAuth scopes for authentication.
                    items:
                      type: string
        '404':
          description: OIDC provider is not configured for this Weaviate instance.
        '500':
          description: An internal server error occurred while retrieving OIDC configuration. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
      operationId: getWellKnownOpenidConfiguration
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      description: An error response returned by Weaviate endpoints.
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OIDC/JWT bearer authentication