NocoDB SDK

We provide SDK for users to integrate with their applications. Currently only SDK for Javascript is supported.

SDK For Javascript

Install nocodb-sdk

npm i nocodb-sdk

Import Api

import { Api } from 'nocodb-sdk'

Configure Api

The Api can be authorizated by either Auth Token or API Token.

Example: Auth Token

const api = new Api({
  baseURL: 'https://<HOST>:<PORT>',
  headers: {
    'xc-auth': '<AUTH_TOKEN>'
  }
})

Example: API Token

const api = new Api({
  baseURL: 'https://<HOST>:<PORT>',
  headers: {
    'xc-token': '<API_TOKEN>'
  }
})

Call Functions

Once you have configured api, you can call different types of APIs by api.<Tag>.<FunctionName>.

Example: Calling API - /api/v1/db/meta/projects/{projectId}/tables

await api.dbTable.create(params)