InstantMLDocs

Settings and API keys

Open the Workspace settings modal to manage plan usage, billing, seats, and SDK API keys.

Open .md

Manage the operational side of your workspace: plan usage, billing, seats, storage, and the SDK keys your training jobs authenticate with.

Open Workspace settings

Settings is a centered Workspace settings modal, not a nav-rail tab. To open it:

  1. Click your account menu in the top-right of the dashboard.
  2. Choose Workspace settings.

The modal has six sections: Plan Usage, Billing, Seats, Workspace, API, and Defaults. It is scoped to the active workspace — the account menu shows which workspace is current, so confirm it before inviting teammates or changing billing. See Organizations and workspaces for the workspace hierarchy and role model.

Check plan usage

The topbar shows a compact plan usage badge. The Plan Usage section shows more detail:

  • Current plan.
  • Metric points this month — usage for the current UTC calendar month.
  • API requests this month — usage for the current UTC calendar month.
  • General API rate and Ingest API rate policies.
  • Monthly reset — the next UTC reset time.
  • Seat usage, storage usage, and accounting notes.

Metric-point and API-request usage reset monthly. Free-plan API request overage is blocked; paid Pro/Premium overage is metered through Stripe. Storage and seats measure what you currently hold, so they do not reset monthly.

Manage billing

The Billing section handles plan changes through hosted billing flows. It exposes plan upgrade/downgrade actions, Open portal for the Stripe customer portal, and Cancel subscription, where your workspace role allows it.

When a workspace is pending payment or payment-failed, write routes can return a payment-required error until billing recovers.

Manage seats and invitations

From the Seats section, admins can invite teammates, resend pending invitations, revoke pending invitations, and see seat accounting that includes active members plus unexpired pending invitations.

Owners and admins can manage seats. Members can write runs, artifacts, reports, and saved views. Viewers can inspect dashboard data but cannot change anything.

Create API keys

SDK keys are managed in the API section of the Workspace settings modal. Owners and admins can create a copy-once key by name, copy it while it is visible, see active and revoked keys with their prefixes, and revoke keys that should no longer be used. An API reference link at the bottom opens the generated route reference.

To connect a coding agent over MCP, use the Agent tab in the nav rail — its setup snippets fill in a key you created here, or use browser sign-in with no key at all.

Store keys in environment variables or a secrets manager:

bash
export INSTANTML_API_KEY="instantml_..."

Use the key for SDK runs:

python
import instantml as im

run = im.init(project="demo")
run.log({"accuracy": 0.94, "loss": 0.18}, step=10)
run.finish()

Or for direct automation:

bash
curl https://api.instantml.ai/projects \
  -H "Authorization: Bearer $INSTANTML_API_KEY"

Never commit API keys, session cookies, Clerk secrets, ClickHouse credentials, or storage credentials.

Choose a storage mode

Hosted artifact bytes can use InstantML-owned storage. Customer-owned ClickHouse setup is handled in onboarding for Premium teams that need to route product data to their own self-hosted GCP ClickHouse deployment. Dashboard and API-key access remain locked until the storage state is ready.

Workspace settings shows storage usage and accounting notes for the active workspace, but the ClickHouse connection form lives in onboarding rather than settings.

Next steps