REST API

Access Serenities programmatically. All endpoints require authentication.

Get Started

Create an API key in your account settings to start making API requests.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer mk_live_your_api_key

Base URL

https://app.serenitiesai.com/api/v1

Request Format

All endpoints use

POST

method with JSON body:

POST /api/v1/{router}/{procedure}
Content-Type: application/json
Authorization: Bearer mk_live_xxx

{
  "param1": "value1",
  "param2": "value2"
}

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/tables/listDatabases \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'

Available Endpoints

Explore the available API endpoints organized by resource type.

Base & Tables

Bases, tables, fields, and records

App Builder

Projects, pages, and components

Flows

Automation flows

App Connections

Connected integrations

Linked Records

Record linking

Sharing

Share links

Files

File management

Error Handling

200

Success

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid or missing API key

403

Forbidden - No subscription or insufficient credits

404

Not Found - Endpoint or resource not found