DEVELOPERS

Build on governed data, not around it.

Use APIs, SDKs, CLI workflows, and machine credentials that carry platform security and observability into every integration.

Request access

DEVELOPER / API LIVE

SDKConnectedWorkspace selected

API keyScopeddatasets:read

Request200 OKPolicy allowed

TraceRecorded148 ms

LAKEPLANE CLOUDPOLICY VERIFIED

3client options

6core API surfaces

1credential per workload

BUILT FOR CONTROL

A complete API surface for governed data automation.

Build integrations with REST APIs, SDKs, CLI workflows, scoped keys, observable jobs, vector search, and AI retrieval primitives.

API-first platform

Automate the same storage, catalog, query, vector, and policy operations available in the console.

Scoped API keys

Grant applications the least privilege required and rotate access without downtime.

CLI workflows

Move from local iteration to repeatable automation with clear environment context.

Event-driven jobs

Start long-running data operations and follow their progress through durable job state.

Retrieval primitives

Connect datasets, vector indexes, policies, citations, and hosted agent workflows.

Observable integrations

Measure requests, latency, errors, quotas, and data-product usage.

DEVELOPER QUICKSTART

From provisioned tenant to first API call.

LakePlane exposes the control plane through versioned REST APIs and thin JavaScript and Python SDKs. Your credential carries workspace scopes; authorization remains enforced by the platform.

01
Get developer access
Ask your tenant administrator for membership in the target workspace and the permissions required by your integration.
02
Create a scoped API key
In LakePlane, open API Keys, choose a workspace, grant the minimum scopes, set an expiry, and copy the secret when it is revealed once.
03
Configure your client
Store the API URL, key, and workspace identifiers in your secret manager. Never embed credentials in browser bundles or source control.
04
Call, trace, and automate
Send the key as a bearer credential, preserve the request ID, follow cursor pagination, and poll durable jobs for long-running work.

CHOOSE YOUR CLIENT

Use REST directly or start with a typed SDK.

SDK packages are provided with approved developer access. They add auth headers, request IDs, typed errors, cursor helpers, safe GET retries, and signed object transfers.

JavaScript / TypeScript@lakeplane/sdk-js

import { LakePlaneClient } from '@lakeplane/sdk-js';

const lakeplane = new LakePlaneClient({
  apiUrl: process.env.LAKEPLANE_API_URL,
  apiKey: process.env.LAKEPLANE_API_KEY,
});

const page = await lakeplane.datasets.list(process.env.LAKEPLANE_WORKSPACE_ID, { limit: 25 });

Python 3.11+lakeplane-sdk

from lakeplane import LakePlaneClient
import os

lakeplane = LakePlaneClient(
    os.environ["LAKEPLANE_API_URL"],
    api_key=os.environ["LAKEPLANE_API_KEY"],
)

page = lakeplane.datasets.list(
    workspace_id=os.environ["LAKEPLANE_WORKSPACE_ID"],
    limit=25,
)

REST / cURLBearer API key

curl "$LAKEPLANE_API_URL/v1/workspaces/$LAKEPLANE_WORKSPACE_ID/datasets?limit=25" \
  -H "Authorization: Bearer $LAKEPLANE_API_KEY" \
  -H "Accept: application/json" \
  -H "X-Request-Id: my-integration-001"

CORE API SURFACES

Build against stable control-plane resources.

All protected operations run identity, relationship, and policy checks before reaching storage, query, vector, or job services.

GET/v1/users/meVerify the current identity and tenant context.

GET/v1/workspaces/{workspace_id}/datasetsList governed datasets available in the authorized workspace.

POST/v1/workspaces/{workspace_id}/queriesSubmit a policy-checked SQL query.

POST/v1/vector-indexes/{index_id}/queryRun governed vector similarity search.

GET/v1/jobs/{job_id}Read durable status for asynchronous operations.

POST/v1/workspaces/{workspace_id}/data-productsCreate a governed, versioned data product for API consumers.

Cursor pagination

Pass limit and cursor, then follow pagination.next_cursor only while another page exists.

Request IDs

Every call carries X-Request-Id. Keep the returned ID when tracing a job or reporting an integration failure.

Typed failures

SDK errors expose safe status, error code, request ID, and details for authentication, authorization, validation, conflict, timeout, and network cases.

CREATE A GOVERNED API

Publish data through a versioned data product.

LakePlane treats an external API as a governed product contract—not a raw route to infrastructure. Tenant administrators control who may publish and who may subscribe.

See the data-product workflow

01Register the product
Create the data product in a workspace and assign its owner, audience, and lifecycle state.
02Attach governed resources
Reference approved datasets, trusted tables, query surfaces, semantic indexes, or retrieval capabilities.
03Define a version
Document endpoint behavior, schemas, quality signals, service objectives, privacy rules, and access terms.
04Publish and authorize
Release the version, approve subscriptions, issue scoped credentials, meter usage, and monitor consumer operations.

THE LAKEPLANE DIFFERENCE

Developer speed with platform guardrails.

Start with familiar REST and SDK patterns
Use one credential model across platform services
Ship AI features with source and policy context
Debug integrations with traceable operations

GET STARTED

Ready to put your data to work?

Already provisioned? Sign in securely. New organization? Request tenant access and our platform team will review and provision your workspace.

Request tenant access

import { LakePlaneClient } from '@lakeplane/sdk-js'; const lakeplane = new LakePlaneClient({ apiUrl: process.env.LAKEPLANE_API_URL, apiKey: process.env.LAKEPLANE_API_KEY, }); const page = await lakeplane.datasets.list(process.env.LAKEPLANE_WORKSPACE_ID, { limit: 25 });

from lakeplane import LakePlaneClient import os lakeplane = LakePlaneClient( os.environ["LAKEPLANE_API_URL"], api_key=os.environ["LAKEPLANE_API_KEY"], ) page = lakeplane.datasets.list( workspace_id=os.environ["LAKEPLANE_WORKSPACE_ID"], limit=25, )

curl "$LAKEPLANE_API_URL/v1/workspaces/$LAKEPLANE_WORKSPACE_ID/datasets?limit=25" \ -H "Authorization: Bearer $LAKEPLANE_API_KEY" \ -H "Accept: application/json" \ -H "X-Request-Id: my-integration-001"