Introduction

Overview

The Redivis REST API is designed to give users and applications programmatic interfaces for the Redivis platform.

This documentation is broken into introductory materials, an "Examples" section, "Client libraries", "Methods", and "Resource definitions".

Before getting started, it is essential to first familiarize yourself with this API's general structure, authorization, and resource reference paradigms.

API Design

This API leverages a RESTful, resource-oriented design. Our goal is to provide a consistency across methods while allowing for an expressive interface.

All methods, request properties, and status codes inherit from the behavior outlined in the General structure section. All definitions of REST resources are provided under the "Resource definitions" header.

Examples