Weaviate objects API

The objects API from Weaviate — 7 operation(s) for objects.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 21 operations across 7 paths, and defines 19 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.

21 operations 7 paths 19 schemas 5 DELETE3 GET2 HEAD2 PATCH5 POST4 PUT

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

Authentication & Security 2

Weaviate objects 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 21

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

objects 21

GET

/objects

Weaviate List Objects

objects.list 8 params → 200400401403404422500

POST

/objects

Weaviate Create An Object

objects.create 1 param body → 200400401403422500

DELETE

/objects/{id}

Weaviate Delete An Object

objects.delete 3 params → 204401403404500

GET

/objects/{id}

Weaviate Get An Object

objects.get 2 params → 200400401403404500

PATCH

/objects/{id}

Weaviate Patch An Object

objects.patch 2 params body → 204400401403404422500

PUT

/objects/{id}

Weaviate Update An Object

objects.update 2 params body → 200401403404422500

HEAD

/objects/{id}

Weaviate Check If An Object Exists

objects.head 1 param → 204401403404500

GET

/objects/{className}/{id}

Weaviate Get An Object

objects.class.get 6 params → 200400401403404422500

DELETE

/objects/{className}/{id}

Weaviate Delete An Object

objects.class.delete 4 params → 204400401403404422500

PUT

/objects/{className}/{id}

Weaviate Replace An Object

objects.class.put 3 params body → 200401403404422500

PATCH

/objects/{className}/{id}

Weaviate Patch An Object

objects.class.patch 3 params body → 204400401403404422500

HEAD

/objects/{className}/{id}

Weaviate Check If An Object Exists

objects.class.head 4 params → 204401403404422500

POST

/objects/{id}/references/{propertyName}

Weaviate Add An Object Reference

objects.references.create 3 params body → 200401403422500

PUT

/objects/{id}/references/{propertyName}

Weaviate Replace Object References

objects.references.update 3 params body → 200401403422500

DELETE

/objects/{id}/references/{propertyName}

Weaviate Delete An Object Reference

objects.references.delete 3 params body → 204401403404500

POST

/objects/{className}/{id}/references/{propertyName}

Weaviate Add An Object Reference

objects.class.references.create 5 params body → 200400401403404422500

PUT

/objects/{className}/{id}/references/{propertyName}

Weaviate Replace Object References

objects.class.references.put 5 params body → 200400401403404422500

DELETE

/objects/{className}/{id}/references/{propertyName}

Weaviate Delete An Object Reference

objects.class.references.delete 5 params body → 204400401403404422500

POST

/objects/validate

Weaviate Validate An Object

objects.validate body → 200401403422500

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

Schemas 19

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

C11yVector

array

A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.

BatchDeleteResponse

object

Delete Objects response.

5 properties

ObjectsListResponse

object

List of objects.

3 properties

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…

Deprecation

object

11 properties

BatchDelete

object

4 properties

Vector

object

A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.

WhereFilter

object

Filter search results using a where filter.

16 properties

ReferenceMetaClassification

object

This meta field contains additional info about the classified reference property

10 properties

ErrorResponse

object

An error response returned by Weaviate endpoints.

1 property

PropertySchema

object

Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.

AdditionalProperties

object

(Response only) Additional meta information about a single object.

Object

object

10 properties

GeoCoordinates

object

2 properties

ObjectsGetResponse

WhereFilterGeoRange

object

Filter within a distance of a georange.

2 properties

SingleRef

object

Either set beacon (direct reference) or set collection (class) and schema (concept reference)

5 properties

MultipleRef

array

Multiple instances of references to other objects.

Vectors

object

A map of named vectors for multi-vector representations.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

#objects

← Back to W APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Weaviate objects API

Metadata

Authentication & Security 2

Paths & Operations 21

Schemas 19

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Weaviate objects API

Metadata

Authentication & Security 2

Paths & Operations 21

Schemas 19

Specification

Source

More from Weaviate 12

API Details

Provider

Explore more