Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.48 KB

RootApi.md

File metadata and controls

59 lines (38 loc) · 1.48 KB
Raw

LiltNode.RootApi

All URIs are relative to https://lilt.com/2

Method HTTP request Description
root GET / Retrieve the REST API root

root

ApiRoot root()

Retrieve the REST API root

This resource does not have any attributes. It lists the name of the REST API. This endpoint can be used to verify REST API keys and to check the availability of the REST API.

Example

import LiltNode from 'lilt-node';
let defaultClient = LiltNode.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure HTTP basic authorization: BasicAuth
let BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME';
BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.RootApi();
apiInstance.root().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

ApiRoot

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json