API Library

API Authentication / Overview

The Essembi REST API lets you read and write table records, pull data model results, and run Data Imports from your own systems. Every call is authenticated with an API key.

curl https://api.essembi.ai/Security/Authenticate \
  -H "Authorization: <API Key>"

Ways to Create and Update Records

• Table record endpoints. Create or edit one record at a time with POST /Tables/{tableId}/Records/Create and PATCH /Tables/{tableId}/Records/{recordId}/Edit.
• Data Import API. Run a configured Data Import with JSON or an uploaded Excel, JSON or delimited file to insert and update many records in one call.
• Essembi FTP + Data Import. Upload files to the Essembi-provided FTP site. Essembi pulls the files into a Data Import for insert and update processing. See Data Imports.

Endpoints

All paths are relative to https://api.essembi.ai.

Execute Data Import via API

Use this endpoint to run the same Data Import configurations available in the app. The Data Import's Transform & Load Script controls insert vs update behavior.

POSThttps://api.essembi.ai/Integrations/DataImport/{dataImportId}

The optional type query parameter sets what the endpoint expects:

Option A: JSON body

Send the header Content-Type: application/json. These JSON shapes are accepted:

• columns (or Columns) as a string array, plus data (or Data) as an array of row arrays.
• columns plus data as an array of objects keyed by column name.
• schema.columns as objects with name, plus data.

{
  "columns": ["Part", "Standard Cost"],
  "data": [
    ["ABC-100", 12.5],
    ["ABC-200", 18.0]
  ]
}

Option B: File upload (Excel / JSON / delimited)

Send multipart/form-data with a file field named file (or the first form file). The file extension must match the Data Import File Type:

• Excel Data Import requires .xlsx.
• JSON Data Import requires .json.
• Delimited Data Import requires delimited text per the import's delimiter settings.

curl -X POST "https://api.essembi.ai/Integrations/DataImport/{dataImportId}?type=excel" \
  -H "Authorization: <API Key>" \
  -F "file=@parts.xlsx"

Responses

A successful run returns success: true, a message, and totalRecordsLoaded.

{
  "success": true,
  "message": "...",
  "totalRecordsLoaded": 2
}

For FTP-based delivery into the same Data Import configurations, see Data Imports.

Data Transfer Objects

Filter Operators

Pass the enum name as the operator string.

RecordValues

Values to assign when creating or updating a record, as an object mapping field id or field name to field value:

{
  "values": {
    "123": "New ticket summary",
    "Status": "Open"
  }
}