Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redem.io/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to the ReDem API documentation! 👋🏼 This documentation provides a step-by-step approach to seamlessly integrating the ReDem API into your workflows and applications. The backbone of our platform is the ReDem API. With our API you have direct access to every feature ReDem offers from real-time data access to smooth integration with your existing applications. Best of all, since the ReDem Application runs entirely on this API, everything you can do in the app, you can also do through the API. No limitations, just endless possibilities!

​
Integration Use Cases

The ReDem API supports two main integration use cases, allowing you to choose the approach that best fits your workflow:

Synchronous Response

Receive an instant evaluation of the respondent’s quality and seamlessly integrate this data into your workflow.

Asynchronous Response

Process respondent quality evaluations in the background and retrieve results later using the Get Respondent/s endpoints.

​
API Versioning

ReDem’s API uses versioned endpoints to ensure backward compatibility while introducing new features. Currently, three API versions are available:
  • v1: Legacy endpoints (deprecated)
  • v2: Introduced consistent CHS question IDs
  • v3: Enhanced OES with improved categories and effort scale (recommended)
Important: You cannot upgrade the API version for a survey that is currently running. Each survey is permanently tied to the API version it was created with. To use a newer API version, you must create a new survey with the updated endpoints.
For detailed migration instructions, see the API Version Migration Guide.

​
Base URL

ReDem’s API is built on REST principles following the OpenAPI standard as much as possible. To ensure data security, it operates exclusively over HTTPS, encrypting all interactions. Unencrypted HTTP connections are not supported, safeguarding your data by default. The Base URL for all API endpoints is: 
https://api.redem.io/
Versioned endpoints use the format: https://api.redem.io/v3/addRespondent.
ReDem’s API is currently in public beta and is subject to change. However, we will do our best to keep breaking changes to a minimum.
Need help or have questions? Contact our support team at support@redem.io. we’re here to help you make the most of ReDem!