SEI API Guide

The SEI services API documentation is now available. You can access it here: SEI Services API Documentation

Overview

Service endpoint

A service endpoint is the base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoints and all URIs below are relative to this service endpoint:

• US: https://api.propelo.ai/

• EU: https://eu1.api.propelo.ai/

Authentication

Use a Propelo API key in the Authorization header:

Authorization: Bearer <SEI_API_KEY>

The API Key can be generated from the SEI application. You can follow the steps below to generate an API Key in SEI.

1. Select the Settings icon in the left navigation menu

2. Select the API KEYS tile under the Integration & Data Settings

3. Click on the Create API Key button at the top right corner

4. Add a name and description for the API Key

5. Choose the role as either Admin or Ingestion. For this use case select the role of Admin.

6. Click on the Create button to generate the API Key.

Content-Type

All payloads are to be in JSON format. Use the following header when making requests:

Content-Type: application/json

Pagination

Some API endpoints that return a list of records support pagination to manage large datasets efficiently.

Request Parameters

Include these parameters in your request payload to control pagination:

{
  "page": 0,
  "page_size": 100
}

Response Metadata

The response will include a _metadata object with pagination information:

{
  "_metadata": {
    "page_size": 100,
    "page": 0,
    "has_next": true,
    "total_count": 256
  }
}

This metadata helps you determine how much more data is available for retrieval in subsequent requests.