Skip to main content
Everything you build on Custral goes through /v1, one versioned, key-authenticated surface at https://api.custral.com. The SDKs, the CLI, and the MCP server are all clients of it, so anything they can do, you can do with curl.

Get your first key

Create an application and mint a scoped API key. Start here.

API Reference

Auth, errors, and every endpoint with copy-pasteable curl.

Pick your surface

TypeScript SDK

@custral/sdk. Typed access to records, objects, and ingest from Node.

Browser SDK

@custral/js, the usage client and error types, for publishable keys.

React SDK

@custral/widget: the chat widget as a component, or its headless engine.

CLI

@custral/cli: sign in, switch orgs, and hit any endpoint from a shell.

MCP

Point Claude or Cursor at your workspace and let the model read your data.

Core concepts

Authentication

Secret vs publishable keys, and the scope model.

How the schema works

Objects, properties, records, and fields: the model everything else uses.

Errors

The response envelope and the full error-code catalog.

Push and receive data

Create records

Push records in from a plain {property: value} map.

Webhooks

Get notified when things change in your workspace.

Real-time

React to changes in a workspace as they happen.
Building something and missing an endpoint? Tell us, the /v1 surface grows from what people actually need.