How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Weaviate

Weaviate schema API

The schema API from Weaviate — 12 operation(s) for schema.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 22 operations across 12 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.38.0-dev.

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

22 operations 12 paths 23 schemas 5 DELETE7 GET1 HEAD5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Weaviate schema 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 22

Across 12 paths, the API surfaces 22 operations — 5 DELETE, 7 GET, 1 HEAD, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

schema 22
GET
/schema
Weaviate Get All Collection Definitions
schema.dump 1 param → 200401403500
POST
/schema
Weaviate Create A New Collection
schema.objects.create body → 200401403422500
GET
/schema/{className}
Weaviate Get A Single Collection
schema.objects.get 2 params → 200401403404500
DELETE
/schema/{className}
Weaviate Delete A Collection (And All Associated Data)
schema.objects.delete 1 param → 200400401403500
PUT
/schema/{className}
Weaviate Update Collection Definition
schema.objects.update 1 param body → 200401403404422500
POST
/schema/{className}/properties
Weaviate Add A Property To A Collection
schema.objects.properties.add 1 param body → 200401403422500
DELETE
/schema/{className}/properties/{propertyName}/index/{indexName}
Weaviate Delete A Property'S Inverted Index
schema.objects.properties.delete 3 params → 200401403422500
POST
/schema/{className}/properties/{propertyName}/tokenize
Weaviate Tokenize Text Using A Property'S Configuration
schema.objects.properties.tokenize 2 params body → 200400401403404422500
DELETE
/schema/{className}/vectors/{vectorIndexName}/index
Weaviate Delete A Collection'S Vector Index.
schema.objects.vectors.delete 2 params → 200401403422500
GET
/schema/{className}/shards
Weaviate Get The Shards Status Of A Collection
schema.objects.shards.get 2 params → 200401403404500
PUT
/schema/{className}/shards/{shardName}
Weaviate Update A Shard Status
schema.objects.shards.update 2 params body → 200422401403404500
POST
/schema/{className}/tenants
Weaviate Create A New Tenant
tenants.create 1 param body → 200401403422500
PUT
/schema/{className}/tenants
Weaviate Update A Tenant
tenants.update 1 param body → 200401403422500
DELETE
/schema/{className}/tenants
Weaviate Delete Tenants
tenants.delete 1 param body → 200401403422500
GET
/schema/{className}/tenants
Weaviate Get The List Of Tenants
tenants.get 2 params → 200401403422500
HEAD
/schema/{className}/tenants/{tenantName}
Weaviate Check If A Tenant Exists
tenant.exists 3 params → 200401403404422500
GET
/schema/{className}/tenants/{tenantName}
Weaviate Get A Specific Tenant
tenants.get.one 3 params → 200401403404422500
GET
/aliases
Weaviate List Aliases
aliases.get 1 param → 200401403422500
POST
/aliases
Weaviate Create A New Alias
aliases.create body → 200401403422500
GET
/aliases/{aliasName}
Weaviate Get An Alias
aliases.get.alias 1 param → 200401403404422500
PUT
/aliases/{aliasName}
Weaviate Update An Alias
aliases.update 1 param body → 200401403404422500
DELETE
/aliases/{aliasName}
Weaviate Delete An Alias
aliases.delete 1 param → 204401403404422500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ReplicationAsyncConfig (14 properties), Class (13 properties), Property (12 properties), InvertedIndexConfig (9 properties). Each schema is shown below with its type and property counts.

BM25Config
object
Tuning parameters for the BM25 algorithm.
2 properties
ShardStatusGetResponse
object
Response body of shard status get request
3 properties
AliasResponse
object
Response object containing a list of alias mappings.
1 property
Schema
object
Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).
3 properties
TextAnalyzerConfig
object
Text analysis options for a property. These settings are immutable after the property is created. Applies only to text and text[] data types that use an invert…
3 properties
Class
object
13 properties
TokenizeResponse
object
Response from the tokenize endpoints. Returns indexed text and text used at query time
2 properties
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
NestedProperty
object
9 properties
InvertedIndexConfig
object
Configure the inverted index built into Weaviate. See [Reference: Inverted index](https://docs.weaviate.io/weaviate/config-refs/indexing/inverted-indexinverted…
9 properties
MultiTenancyConfig
object
Configuration related to multi-tenancy within a collection (class)
3 properties
Property
object
12 properties
StopwordConfig
object
Fine-grained control over stopword list usage.
3 properties
VectorConfig
object
3 properties
ShardStatusList
array
The status of all the shards of a Class
ObjectTtlConfig
object
Configuration of objects' time-to-live
4 properties
TokenizerUserDictConfig
object
A list of pairs of strings that should be replaced with another string during tokenization.
2 properties
ReplicationAsyncConfig
object
Configuration for asynchronous replication.
14 properties
ShardStatus
object
The status of a single shard
1 property
ReplicationConfig
object
Configure how replication is executed in a cluster
4 properties
Alias
object
Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection.
2 properties
Tenant
object
Attributes representing a single tenant within Weaviate.
2 properties
PropertyTokenizeRequest
object
Request body for the property-specific tokenize endpoint.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-schema-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
AE Profile APIs.io
Weaviate backups API
AE Profile APIs.io
Weaviate batch API
AE Profile APIs.io
Weaviate classifications API
AE Profile APIs.io
Weaviate cluster API
AE Profile APIs.io
Weaviate discovery API
AE Profile APIs.io
Weaviate distributedTasks API
AE Profile APIs.io
Weaviate export API
AE Profile APIs.io
Weaviate graphql API
AE Profile APIs.io
Weaviate mcp API
AE Profile APIs.io
Weaviate meta API
AE Profile APIs.io
Weaviate namespaces API
AE Profile APIs.io
#Schema
← Back to W APIs
API Details
ID
weaviate:weaviate-schema-api
Server
http://localhost:8080
Docs
https://weaviate.io/developers/weaviate/api/rest
Provider
Weaviate
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=weaviate-schema-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/weaviate-schema-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Weaviate schema API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.