usage

The methods of pd.usage. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.usage.listTransactions(input, init?)

The credit ledger, newest first

GET /api/workspaces/{workspaceId}/transactions

Requires credits.read. The credit ledger is append-only: every credit and debit is a row, and rows are never updated or deleted. amount is signed against the available credits and type says what the row records. Returns up to limit rows, at most 200, and has no offset.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.usage.listTransactions({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.usage.get(input, init?)

Usage records, filterable by window, project, user, operation and provider

GET /api/workspaces/{workspaceId}/usage

Requires analytics.read. Returns two views of the usage records that match the filters: summary groups them by operation type, provider and model, and records lists the newest ones up to limit. Usage records say what providers were asked to do, with an estimated provider cost in USD micros; they are kept apart from the credits charged. In summary, credits and estimatedProviderCostMicros are bigint sums and arrive as decimal strings. costKnown false means the model has no known rate, so a cost of 0 is absence of data, not a free call.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.usage.get({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.usage.listPayments(input, init?)

Checkout and payment history

GET /api/workspaces/{workspaceId}/payments

Requires billing.read. Lists the workspace's credit-pack checkouts, newest first, at most 50. Pending, expired and failed checkouts are listed too; only completed ones added credits. Subscription payments are not here: they are the invoices of GET /api/workspaces/{workspaceId}/subscription. Card details and Stripe customer identifiers are never returned.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.usage.listPayments({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.usage.listQuotas(input, init?)

Quota limits and current consumption

GET /api/workspaces/{workspaceId}/quotas

Requires billing.read. Lists the quotas configured for the workspace with what has been used against each. Quotas are entitlements kept apart from the credit balance: a workspace holding credits is still refused with 429 QUOTA_EXCEEDED once a quota is used up. A metric with no entry is unlimited. The limits a plan sets (users, projects, ai_operations) are listed here too. Entries do not say which period they count over.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.usage.listQuotas({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.usage.setQuota(input, init?)

Set or clear a quota

PUT /api/workspaces/{workspaceId}/quotas

Requires billing.manage. Sets the limit of one metric for a period, or removes it when limitValue is null, which leaves the metric unlimited. users, projects and ai_operations belong to the workspace's plan, which rewrites them on every subscription event, so they are refused with 400. Records a billing.quota_changed audit entry and returns the full quota list, as the read route does.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.usage.setQuota({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    metric: "articles",
    limitValue: 1,
  },
});
console.log(result);