Skip to main content

Sequen API Overview

Welcome to the Sequen REST API reference. Our APIs allow you to integrate Sequen’s powerful reinforcement learning-based personalization features into your applications.

Base URL

All Sequen API endpoints are accessed via the following base URL:

Authentication

All requests to the Sequen API must be authenticated. We use API Keys for authentication. Include your API key in the Authorization header of your requests. See the Authentication guide for details.

Versioning

The API version is included in the URL path (/v1). Breaking changes will result in a new version number.

Request Format

  • Sequen APIs generally accept JSON-formatted request bodies for POST, PUT, and PATCH requests.
  • Set the Content-Type header to application/json.

Response Format

  • Responses are returned in JSON format.
  • Successful requests typically return a 2xx status code.
  • Client errors (e.g., invalid parameters, missing authentication) return a 4xx status code.
  • Server errors return a 5xx status code.
  • Error responses include a JSON body. Its fields depend on where the error occurs.
  • Authentication errors (401) carry error and message fields.
  • Other errors from POST /v1/recommend carry error and request_id fields. The request_id field identifies the request.
Error Response Example (400 from POST /v1/recommend)

Rate Limiting

API requests are rate-limited. If you exceed the limit, you will receive a 429 Too Many Requests response. Navigate through the API sections using the sidebar to explore specific endpoints.