Skip to main content

Overview

Welcome to the API documentation for Objective Search. This site contains information about how to access and use the APIs. If you have questions, or find something is not covered in this doc, please let us know.

Objective Search empowers developers with a plug-and-play search API that works on multiple media types - in particular, complex Objects composed of embedded text and links to images.

To get an API key sign up at https://app.objective.inc. To see more of what Objective Search can do, check out our live demos.

Platform overview

At its core, the Objective platform stores your Objects and enables you to build Indexes from those Objects for the purpose of searching.

Objects are schemaless, and can contain both structured and unstructured data. You'll use the Objects API to store and manage Objects in the Object Store.

Objects in the Object Store can then be added to one or more Indexes using the Create Index API. Being added to an Index makes an Object searchable. When creating an Index, you're able to choose specific fields from your Objects to index, such as title, description and image_url. Indexes are kept up to date as you make updates to the underlying Objects in the Object Store.

Finally, after having added your Objects to one or more Indexes, you'll use the Search API to issue search requests against your Indexes.

Objective Search API integration model

Objective Search API integration model

download as pdf

Key concepts

The Object Store and Objects

All data added to the platform is stored in the Object Store. The Object Store is a collection of schemaless Objects, which are represented using JSON. An Object's fields can be searchable text (represented as Strings), URLs to images that the platform should crawl (also represented as Strings) as well as other JSON data types (arrays, numbers, dates, booleans, and nested JSON).

Indexes

Indexes are built from Objects in the Object Store, according to composition rules that you define. Adding Objects to an Index is what makes them searchable. Once an Index is built, you can query the Objects in that Index using the /search API.

Highlights

When you search an Index, the API returns relevant Objects along with Highlights. A Highlight represents the most relevant portions of a matching Object, be it a section of text or an image.