Getting started

Welcome to the Spark API documentation! We have documented the important APIs used to call and manage Spark services!

Base URL

https://excel.{environment}.coherent.global

The environment is part of your Log in to Spark URL.

Spark object model

Folder	Folder can contain documents, services, and transform documents. For legacy v1 APIs, this may be referred to as a "product". Actions to manage folders: Folder APIs
Documents	Documents can be uploaded into a Folder.
Service	Services are created in a folder. A service is the representation of the Excel converted to code and into an API. For legacy v1 APIs, this may be referred to as an "engine". Actions to manage services: ImpEx APIs Service APIs
Service versions	As changes are made to a single service, new service versions are created. When "running" on a service, a service version needs to be resolved or targeted. Actions to run service versions: Batch APIs Execute API Metadata API Validation API
WebAssembly module	Each service version includes code compiled from Excel into C++, then into a WebAssembly module ZIP bundle by Neuron. These bundles can be downloaded for offline execution. Actions on Wasm ZIP bundles: WebAssembly module API
API calls	When an API call is made to a service version, the request and response data is saved into the API Call History. Actions to retrieve from the API Call History: API Call History APIs
Transform documents	Transform documents contain the instructions on how to translate requests and responses to be compatible with the Spark Execute API. Actions on Transform documents: Transforms API

Authorization

Depending on the API, there are different authentication options available:

API keys

Authorization - API keys

Bearer token

Authorization - Bearer token

Compression

The following request headers are supported for compression of requests and responses.

Key	Value
Accept-Encoding	When set to gzip or br, the API response is compressed. If using Postman, this is automatically added.
Content-Encoding	When set to gzip or br or deflate, apply the associated compression to the request body and submit the request body in binary format.

OpenAPI Specification

We are working to document our APIs using the OpenAPI Specification.

Spark OpenAPI Specification

Documentation scope

APIs that are not documented here may be subject to change without notice.