Skip to main content
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sales Analytics",
    "connectionType": "DATASOURCE",
    "datasourceName": "postgres-main"
  }'

{
  "data": {
    "name": "Sales Analytics"
  },
  "error": null
}
POST
https://api.usedatabrain.com
/
api
/
v2
/
workspace
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sales Analytics",
    "connectionType": "DATASOURCE",
    "datasourceName": "postgres-main"
  }'

{
  "data": {
    "name": "Sales Analytics"
  },
  "error": null
}
Create workspaces to organize your analytics environment by connecting datasources or datamarts. Workspaces serve as containers for dashboards and metrics, providing structured access to your data.
Workspaces must be connected to either a datasource, datamart, or configured for multiple datasources. Ensure your datasource or datamart exists before creating a workspace.

​
Authentication

All API requests must include your API key in the Authorization header. Get your API token when creating a data app - see our data app creation guide for details. Finding your API token: For detailed instructions, see the API Token guide.

​
Headers

​
Authorization
string
required
Bearer token for API authentication. Use your API key from the data app.
Authorization: Bearer dbn_live_abc123...
​
Content-Type
string
required
Must be set to application/json for all requests.
Content-Type: application/json

​
Request Body

​
name
string
required
Name of the workspace to create. Must be unique within your organization.
​
connectionType
string
required
Type of connection for the workspace. Must be one of: DATASOURCE, DATAMART, or MULTI_DATASOURCE.
​
datasourceName
string
Name of the datasource to connect to this workspace.Required when connectionType is DATASOURCE.
​
datamartName
string
Name of the datamart to connect to this workspace.Required when connectionType is DATAMART.

​
Response

​
data
object
Contains the created workspace information on success.
​
error
null | object
Error object if the request failed, otherwise null for successful requests.

​
Examples

​
HTTP Status Code Summary

Status CodeDescription
200OK - Workspace created successfully
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing API key
500Internal Server Error - Server error occurred

​
Possible Errors

Error CodeHTTP StatusDescription
INVALID_REQUEST_BODY400Missing or invalid parameters
WORKSPACE_NAME_ALREADY_EXISTS400Workspace name already exists
INVALID_DATASOURCE_NAME400Datasource not found
INVALID_DATAMART_NAME400Datamart not found
INVALID_DATA_APP_API_KEY401Invalid API key
INTERNAL_SERVER_ERROR500Server error

​
Quick Start Guide

1

Verify prerequisites

Before creating a workspace, ensure you have:
  • A valid API token from your data app
  • Either a datasource or datamart already configured
  • The exact name of your datasource or datamart (case-sensitive)
2

Choose your connection type

Decide which connection type fits your use case:
  • DATASOURCE: For connecting to a single data source
  • DATAMART: For connecting to a pre-configured datamart with table/column configurations
  • MULTI_DATASOURCE: For workspaces that need access to multiple datasources
Start with DATASOURCE for simple use cases. Use DATAMART when you need structured access with tenancy settings.
3

Create your workspace

Make the API call with your chosen configuration:
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My Analytics Workspace",
    "connectionType": "DATASOURCE",
    "datasourceName": "postgres-main"
  }'
Successful response returns the workspace name. Save this for use in embed configurations.
4

Use your workspace

Reference your workspace in dashboards and metrics:
const embedConfig = {
  workspaceName: 'My Analytics Workspace',
  // ... other configuration
};