Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Teable Base API

Postgres-backed databases within a space.

Teable Base API is one of 7 APIs that Teable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Base. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://app.teable.io/api, https://app.teable.ai/api.

6 operations 3 paths 3 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.teable.io/api
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Teable Base API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Personal access token or OAuth access token passed as Authorization: Bearer {accesstoken}.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Base 6

Postgres-backed databases within a space.

GET
/bases
List bases
getBaseList → 200
POST
/bases
Create a base
createBase body → 201
GET
/bases/{baseId}
Get a base
getBase 1 param → 200
PATCH
/bases/{baseId}
Update a base
updateBase 1 param body → 200
DELETE
/bases/{baseId}
Delete a base
deleteBase 1 param → 200
POST
/bases/{baseId}/duplicate
Duplicate a base
duplicateBase 1 param → 201

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Base (4 properties), CreateBaseRequest (3 properties), UpdateBaseRequest (2 properties). Each schema is shown below with its type and property counts.

UpdateBaseRequest
object
2 properties
Base
object
4 properties
CreateBaseRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teable-base-api-openapi.yml Raw ↑

Other APIs Teable publishes across the network.

Teable Attachment API
Teable Field API
Teable Record API
Teable Space API
Teable Table API
Teable View API