Introduction

Cube exposes three HTTP API families, each for a different job and with slightly different authentication:

The exact header for each is shown above. The Platform and SCIM schemes are detailed on the Authentication page; the Core Data and AI headers are also documented on their own reference pages.

Available endpoints

Each API family has its own base URL — copy the exact host from the Cube interface where noted. Only HTTPS is accepted, and every request must be authenticated (see Authentication).

Core Data API

Base URL — your deployment's data API host (the /cubejs-api base path is configurable):

https://{deployment}.{region}.cubecloudapp.dev/cubejs-api

AI API

Base URL — your agent's Chat API URL (copy it from Admin → Agents → Chat API URL):

https://ai.{cloudRegion}.cubecloud.dev/api/v1/public/{accountName}/agents/{agentId}

Platform API

Base URL — your tenant host:

https://{tenant}.cubecloud.dev

Endpoints live under three path prefixes on that host, all taking the same token:

Resources by entity:

Client libraries

Core Data API

Query the Core Data API from JavaScript or TypeScript with Cube's JS client, @cubejs-client/core, which also ships React, Vue, and Angular bindings and a WebSocket transport for real-time updates. See the JavaScript SDK reference for full usage.

npm install @cubejs-client/core

Platform API

The recommended way to call the Platform API from JavaScript or TypeScript is the official client, @cube-dev/platform-client. It wraps the OpenAPI spec on this site with end-to-end types for every endpoint, request, and response, plus optional React Query bindings.

npm install @cube-dev/platform-client

yarn add @cube-dev/platform-client

pnpm add @cube-dev/platform-client

Create a client with your tenant's base URL and an auth header (see Authentication), then call any endpoint through the fully-typed fetchClient:

import { createCubePlatformClient } from '@cube-dev/platform-client';

const client = createCubePlatformClient({
  baseUrl: 'https://<tenant>.cubecloud.dev',
  // Returned on every request — provide the Platform API auth header.
  getHeaders: () => ({ Authorization: `Bearer ${process.env.CUBE_API_KEY}` }),
});

const { data, error } = await client.fetchClient.GET('/api/v1/deployments/', {
  params: { query: { first: 50 } },
});

for (const deployment of data?.items ?? []) {
  console.log(deployment.id, deployment.name);
}

React Query bindings

The @cube-dev/platform-client/react-query entry point adds a provider and typed hooks built on @tanstack/react-query (a peer dependency alongside react):

import { createCubePlatformClient } from '@cube-dev/platform-client';
import {
  CubePlatformApiProvider,
  useCubePlatformApiQuery,
} from '@cube-dev/platform-client/react-query';

const client = createCubePlatformClient({ baseUrl, getHeaders });

function App() {
  return (
    <CubePlatformApiProvider client={client}>
      <Deployments />
    </CubePlatformApiProvider>
  );
}

function Deployments() {
  const { data } = useCubePlatformApiQuery('get', '/api/v1/deployments/');
  return <ul>{data?.items.map((d) => <li key={d.id}>{d.name}</li>)}</ul>;
}