canonical: https://jentic.com/apis/nocodb.com/nocodb

# NocoDB v2

NocoDB v2 is the API surface of the open-source no-code database that turns relational data sources into spreadsheet-style bases, tables, views, and shared apps. The 143-endpoint catalog covers base and source management, table and column definition, grid/form/gallery/kanban/map view configuration, hooks, filters, comments, audits, plugins, and shared base/ERD lifecycle. Authentication is by JWT-based xc-auth header for authenticated calls and shared base/ERD ids for read-only public access. The base URL points at a self-hosted NocoDB instance, so deployments substitute their own host (NocoDB Cloud or self-hosted).

## For AI agents

Build and operate NocoDB bases - define tables, views, columns, hooks, and filters, run audits, and manage shared apps across 143 endpoints.

## Scope

Does not handle row-level CRUD on user data tables (covered by NocoDB's data API) or hosting infrastructure - use for NocoDB metadata, view, hook, and audit operations only.

## Capabilities

- Manage NocoDB bases and connected sources via /api/v2/meta/bases and /api/v2/meta/bases/{baseId}/sources
- Define and configure tables, columns, and primary keys through the meta column endpoints
- Configure grid, form, gallery, kanban, and map views with their per-column settings
- Set up hooks and hook filters to trigger external systems when records change
- Manage filters, comments, and row-level audits across bases via /api/v2/meta/audits and related endpoints
- Provision base-level API tokens and run plugin tests through /api/v2/meta/plugins

## Use cases

### Spreadsheet-to-API Workflow

Operations and ops-engineering teams use NocoDB to expose a relational database as a spreadsheet UI plus REST API. The meta endpoints let an automation define new bases, add tables and columns, and configure grid or kanban views without manual clicking. Combined with the row-level CRUD endpoints (handled separately by NocoDB's data API), this turns a NocoDB instance into a programmatic backoffice in minutes.

Example prompt: POST /api/v2/meta/bases to create a base, then add tables via /api/v2/meta/bases/{baseId}/{sourceId}/tables and configure a grid view

### Hooks-Driven Integration

Teams wiring NocoDB into downstream systems need event hooks that fire on row create, update, or delete. The /api/v2/meta/hooks/{hookId} and /api/v2/meta/hooks/{hookId}/filters endpoints let an automation register a hook with conditional filters, then inspect /api/v2/meta/hooks/{hookId}/logs to debug delivery. This keeps NocoDB as the system of record while pushing changes to webhooks, queues, or downstream services.

Example prompt: Register a hook on a table via /api/v2/meta/hooks/{hookId}, attach filter rules through /api/v2/meta/hooks/{hookId}/filters, and tail /api/v2/meta/hooks/{hookId}/logs

### Compliance and Audit Trail

Compliance teams running NocoDB as a lightweight operational database need a structured audit trail of who changed which row and when. The /api/v2/meta/audits/comments and /api/v2/meta/bases/{baseId}/audits endpoints expose audit entries and per-row comments so a daily export can flow into a SIEM or compliance dashboard. Filters narrow the export to specific bases or time windows.

Example prompt: Call /api/v2/meta/bases/{baseId}/audits with a date range and stream the result into a SIEM ingest endpoint

### AI Agent Workspace Builder

An agent provisioning workspaces for new teams can use Jentic to create a NocoDB base, add tables and views, and set up hooks without juggling dozens of meta endpoints by hand. Jentic search routes 'create a nocodb base' to the right operation, loads the schema, and executes with the JWT injected. The same agent can then iterate on column definitions and views.

Example prompt: Use Jentic to call /api/v2/meta/bases to create a base, then /api/v2/meta/bases/{baseId}/{sourceId}/tables to scaffold tables for the new workspace

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v2/meta/bases | List NocoDB bases |
| POST | /api/v2/meta/bases | Create a new base |
| GET | /api/v2/meta/bases/{baseId}/tables | List tables in a base |
| PATCH | /api/v2/meta/columns/{columnId} | Update a column definition |
| GET | /api/v2/meta/bases/{baseId}/audits | Retrieve audit entries for a base |
| PATCH | /api/v2/meta/hooks/{hookId} | Update a hook configuration |
| GET | /api/v2/meta/hooks/{hookId}/logs | Inspect hook delivery logs |
| GET | /api/v2/meta/bases/{baseId}/api-tokens | List API tokens scoped to a base |

## Key resources

- **Bases** — Create, configure, and inspect NocoDB bases and their sources
- **Tables and Columns** — Define tables, columns, and primary key relationships
- **Views** — Configure grid, form, gallery, kanban, and map views with column settings
- **Hooks** — Register hooks, filters, and inspect delivery logs for downstream integrations
- **Filters and Audits** — Manage filter trees and row-level audit comments and history
- **Plugins and API Tokens** — Provision base-scoped API tokens and run plugin webhooks and tests

## Why Jentic

- **Setup:** Wiring NocoDB metadata by hand means adding its API key, pointing at your own NocoDB host instead of a fixed vendor URL, and threading base, column, and hook ids through each path yourself. Through Jentic you install once, import the NocoDB v2 API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** NocoDB puts the base id in the URL path (/api/v2/meta/bases/{baseId}/...), so a rule can pin your agent to one base: it can list that base's tables and read its audits and nothing else. You choose the operations it may call, so ones like updating a column or hook are not included unless you add them.
- **Credential handling:** Your NocoDB API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list tables in a base' or 'read a base's audit log', and Jentic returns the matching NocoDB operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Airtable API** — Airtable is a hosted spreadsheet-database with a polished UI and a similarly-shaped REST surface.
- **SeaTable API** — SeaTable provides another spreadsheet-database hybrid with collaboration features.
- **Supabase API** — Supabase provides Postgres-backed APIs and auth that pair well with NocoDB as a frontend metadata layer over the same data.

## FAQ

### What authentication does the NocoDB API use?

NocoDB uses an apiKey via the xc-auth header carrying a JWT issued for the logged-in user, with a default 10-hour lifetime governed by NC_JWT_EXPIRES_IN. Shared base and ERD endpoints accept xc-shared-base-id and xc-shared-erd-id for unauthenticated read access. Through Jentic the JWT lives in the vault.

### Can I create a new base programmatically with the NocoDB API?

Yes. POST /api/v2/meta/bases creates a base, then /api/v2/meta/bases/{baseId}/sources connects a data source. /api/v2/meta/bases/{baseId}/{sourceId}/tables creates tables under the source.

### What are the rate limits for the NocoDB API?

NocoDB is typically self-hosted, so rate limits depend on the deployment (NocoDB Cloud or self-hosted). The OpenAPI spec does not declare hard limits. Jentic handles 429 responses if the deployment enforces them.

### How do I configure a hook on a NocoDB table through Jentic?

Run pip install jentic, search Jentic for 'create a nocodb hook', load the /api/v2/meta/hooks/{hookId} operation, configure the hook body and attach filters via /api/v2/meta/hooks/{hookId}/filters, then execute. Jentic injects the xc-auth JWT.

### Is NocoDB free to use?

NocoDB is open-source and free to self-host. NocoDB Cloud offers managed pricing tiers - check nocodb.com for current plans. The API surface is identical between self-hosted and Cloud deployments.

### Can I export audit logs from NocoDB?

Yes. /api/v2/meta/bases/{baseId}/audits returns base-scoped audit entries and /api/v2/meta/audits/comments exposes row-level comments. Combine with date filters to export a compliance trail.

### Can I limit what my agent is allowed to do with the NocoDB v2 API?

Yes. Because you run Jentic One yourself, your own rules decide which NocoDB operations and credentials the agent may use. Since the base id sits in the URL path (/api/v2/meta/bases/{baseId}/...), a rule can pin the agent to a single base so it can list that base's tables and read its audits and nothing more. You pick the exact operations it may call, so write actions like updating a column (PATCH /api/v2/meta/columns/{columnId}) or a hook (PATCH /api/v2/meta/hooks/{hookId}) stay off the table unless you add them.