Workspace

Workspace management and token balance operations.

Endpoints

Endpoint	Arguments	Returns
v3.workspace.tokens.balance	workspaceId: string	object
v3.workspace.tokens.deduct	workspaceId: string, serviceKey: string, amount: number, currency: string, meta?: object	object

v3.workspace.tokens.balance

Description

Get the current token balance for a workspace.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.workspace.tokens.balance', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
workspaceId	WorkspaceId	yes	workspaceId (former networkId)
balance	number	yes
lastUpdated	number	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.workspace.tokens.deduct

Description

Deduct tokens from a workspace balance for a specific service.Requires a valid service key. The amount is specified in the given currency (hailerTokens, eur, or usd).

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
workspaceId	WorkspaceId	yes	workspaceId (former networkId)
serviceKey	string	yes
amount	number	yes
currency	hailerTokens | eur | usd	yes	One of: hailerTokens, eur, usd.
meta	object	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.workspace.tokens.deduct', [
  {
    workspaceId: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
    serviceKey: 'string',
    amount: 0,
    currency: 'hailerTokens',
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
workspaceId	WorkspaceId	yes	workspaceId (former networkId)
balance	number	yes
lastUpdated	number	yes
tokensDeducted	number	yes
transactionId	string	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.