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 batch API

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

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

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

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

3 operations 2 paths 17 schemas 1 DELETE2 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 batch 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 2 paths, the API surfaces 3 operations — 1 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.

batch 3
POST
/batch/objects
Weaviate Create Objects In Batch
batch.objects.create 1 param body → 200400401403422500
DELETE
/batch/objects
Weaviate Delete Objects In Batch
batch.objects.delete 2 params body → 200400401403422500
POST
/batch/references
Weaviate Create Cross-References In Bulk
batch.references.create 1 param body → 200400401403422500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are WhereFilter (16 properties), Deprecation (11 properties), Object (10 properties), BatchDeleteResponse (5 properties). Each schema is shown below with its type and property counts.

AdditionalProperties
object
(Response only) Additional meta information about a single object.
Deprecation
object
11 properties
C11yVector
array
A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.
WhereFilterGeoRange
object
Filter within a distance of a georange.
2 properties
BatchDeleteResponse
object
Delete Objects response.
5 properties
Object
object
10 properties
PropertySchema
object
Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.
BatchDelete
object
4 properties
GeoCoordinates
object
2 properties
Vector
object
A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.
VectorWeights
object
Allow custom overrides of vector weights as math expressions. E.g. pancake: 7 will set the weight for the word pancake to 7 in the vectorization, whereas w 3 w…
WhereFilter
object
Filter search results using a where filter.
16 properties
ObjectsGetResponse
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
BatchReferenceResponse
BatchReference
object
3 properties
Vectors
object
A map of named vectors for multi-vector representations.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-batch-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
Weaviate backups 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
Weaviate nodes API