Connect with the database REST API

Plan availability #

Allowances follow the published Chatigram pricing page. Your organization’s Billing & Plans screen confirms its subscription and current usage. Plans can change. Plan information reviewed 2026-11-10.

Enable your database API #

Each enabled database provides an automatically generated REST API for its data. Use it to connect a CRM, ERP, reporting tool, or your own server-side application.

1. Open the database’s settings and turn on Enable API Access.
2. Save the settings, then return to the database overview.
3. In API, check the status and copy the API Base URL.
4. Select Generate API Key. Copy the key when it is revealed and store it in your application’s secret storage. This is the only time that key is shown.
5. Select Download OpenAPI Spec for the API documentation tailored to the database.

The key grants access to the database’s data API. Keep it out of browser code, public repositories, copied workflow examples, screenshots, and AI prompts. Use Regenerate API Key when you need a replacement, and update the applications that use it.

Read the OpenAPI specification #

The downloaded specification describes the available operations, authentication, request bodies, and responses. Open it in an OpenAPI-compatible viewer or import it into your API client. Download a fresh copy after changing tables or columns.

Use the API Base URL displayed in your own database overview. The examples below use placeholders and do not contain a working address or key.

Make a first read request #

Send an Authorization header containing Bearer followed by the database API key. For a table named Requests, a request looks like this:

GET YOUR_DATABASE_API_BASE_URL/tables/Requests/rows?page=0&pageSize=50
Authorization: Bearer YOUR_DATABASE_API_KEY

Pages start at zero. Listing rows defaults to 50 rows per page and caps pageSize at 100. Rows include the system fields _id and _createdAt as well as your named columns. URL-encode table names containing spaces or other special characters.

Create and update records #

For a table using the columns from the JSON import example, create one row with:

POST YOUR_DATABASE_API_BASE_URL/tables/Requests/rows
Authorization: Bearer YOUR_DATABASE_API_KEY
Content-Type: application/json

{
  "Name": "Example customer",
  "Request": "Please arrange a product demonstration",
  "Priority": 2,
  "Resolved": false
}

Use the returned _id to target that record. A partial update leaves omitted columns unchanged:

PATCH YOUR_DATABASE_API_BASE_URL/tables/Requests/rows/ROW_ID
Authorization: Bearer YOUR_DATABASE_API_KEY
Content-Type: application/json

{ "Resolved": true }

Choose an operation #

Use your downloaded specification for query operations, image handling, webhook subscriptions, and the exact supported schemas. The create-row operation accepts one row object; the editor’s multiple-row save is a separate feature.

Troubleshoot the connection #

Check that API access is enabled, the key belongs to the intended database, the authorization header uses the Bearer format, and table and column names match the current structure. Re-download the specification if your client was built against an older table definition.

Review failed writes before retrying: repeating a successful create can produce another record. Test with fictional data before connecting a live business process. Continue with database events when another system needs to react to changes.