Skip to main content

API

We support a CRUD API for managing Objects in the Object Store. Currently we support the following methods:

These endpoints can be used for managing Objects in a catalog and syncing updates from your backend.

Each endpoint is schemaless, meaning we support passing any valid JSON object.

Example - add and delete data from a catalog

Example: Upsert object to catalog, then delete the object
$ curl -X 'PUT' https://api.objective.inc/v1/objects/123 \
-H 'Authorization: Bearer sk_NefoODAZoyA45KsLsQu6J' \
-d {
"id": 123,
"title": "title of the object"
}
// Returns back a JSON object with the ID of the created object
// This object will be added to the index on the next build, and thus
// will appear in downstream APIs (e.g. /search).
{"id": "123"}

$ curl -X 'DELETE' https://api.objective.inc/v1/objects/123 \
-H 'Authorization: Bearer sk_NefoODAZoyA45KsLsQu6J'
// Returns back a JSON object with the ID of the object that was successfully deleted
{"id": "123"}