Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/administration/accounts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Accounts
description: Sign up, manage sign-in methods, update your profile and security settings, and delete your account.
---

# Accounts

An account is your individual identity on the Speechmatics platform. Accounts belong to one or more [workspaces](/administration/workspaces-concepts), where you act as either an Admin or a Member.

## Sign up and verification

1. Go to [portal.speechmatics.com/signup](https://portal.speechmatics.com/signup).
2. Sign up with email and password, or with a supported OAuth provider (Google or GitHub).
3. If you signed up with email, verify your email address using the link sent to your inbox.

If your email address matches a [verified domain](/administration/domain-verification), you join that workspace automatically. Otherwise, a new workspace is created for you.

## Sign-in methods

You can sign in with email and password, or with a connected OAuth account. Speechmatics supports Google and GitHub. Manage connected accounts under **Settings > Profile > User**.

The available sign-in methods are determined by your workspace. If your workspace has [SSO](/administration/sso) enabled, sign in through your identity provider instead.

## Profile and security

Go to **Settings > Profile** in the portal to manage your account.

- **User**: update your name, view your email address, and manage connected OAuth accounts.
- **Security**: change your password and manage multi-factor authentication (MFA).
- **Signed-in devices**: view active sessions and sign out of individual devices or all other devices at once.

## Delete your account

Deleting your account is permanent. You will no longer be able to create an account with the same email address.

1. Go to **Settings > Profile > User**.
2. In the **Delete account** section, click **Delete account**.
3. Confirm the deletion.

You cannot delete your account while you are an Admin in any workspace. Transfer Admin access to another member first, or contact [support@speechmatics.com](mailto:support@speechmatics.com).

## Next steps

- [Workspaces concepts](/administration/workspaces-concepts): how workspaces organize members, projects, and billing.
- [Single sign-on (SSO)](/administration/sso): sign in through your organization's identity provider.
53 changes: 53 additions & 0 deletions docs/administration/api-keys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: API keys
description: Create, view, and revoke the API keys that authenticate your applications to Speechmatics.
---

# API keys

An API key authenticates requests to the Speech to Text and Text to Speech APIs. Each key is scoped to a single [project](/administration/projects): it can access only the transcripts produced within that project. For how keys are used in requests, see [Authentication](/get-started/authentication).

API keys differ from [management tokens](/administration/management-tokens). API keys authenticate transcription and synthesis requests and are scoped to a project. Management tokens authenticate workspace administration and are scoped to the workspace.

## Create an API key

API keys are created within your active project. To create a key in a different project, switch projects first. See [Projects](/administration/projects#switch-between-projects).

1. Go to **API keys** in the sidebar under **Projects**.
2. Click **Create new key**.
3. Enter a descriptive name for the key.
4. Click **Generate new key**.
5. Copy the key value from the dialog.

:::warning
You cannot access the key value again after closing this dialog. Store it in a secure location immediately.
:::

## Revoke an API key

Revoking a key disables it immediately. Requests made with the key are rejected, which may break any application that depends on it.

1. Go to **API keys** in the sidebar under **Projects**.
2. Click the delete button next to the key.
3. Confirm the removal.

## Manage API keys with the API

You can manage API keys programmatically with the Management API, authenticated with a [management token](/administration/management-tokens). Available operations include:

- [Get all API keys](/api-ref/management/get-all-api-keys)
- [Create an API key](/api-ref/management/create-an-api-key)
- [Delete an API key](/api-ref/management/delete-an-api-key)

## API key best practices

- **Use descriptive names.** Name keys after the application or environment that uses them, so you can audit and revoke the right key later.
- **Scope keys to projects.** Create keys in the project that matches their purpose to keep transcripts and usage isolated.
- **Rotate keys periodically.** Create a replacement key, update your application, then revoke the old one.
- **Revoke unused keys.** Remove any key that is no longer in use.

## Next steps

- [Authentication](/get-started/authentication): how to use API keys in requests.
- [Projects](/administration/projects): scope keys by creating them in the right project.
- [Management tokens](/administration/management-tokens): automate key management programmatically.
47 changes: 47 additions & 0 deletions docs/administration/billing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Billing
description: Manage your Pro payment card, and view and download invoices.
---

# Billing

On the Billing page you add or manage your payment card and review what you have been charged. Free users add a card here to upgrade to Pro. Managing billing requires the Admin role.

:::info
Enterprise billing is handled through a contract, not a payment card. The card and invoices described here apply to the Pro plan only. See [Enterprise](/administration/plans#enterprise).
:::

## Add or edit a payment card

Adding a card upgrades a Free plan to Pro. See [Plans](/administration/plans).

1. Go to **Billing** in the sidebar under **Workspace**.
2. In the **Payment method** section, click **Add payment card**, or **Edit payment information** if you already have a card.
3. Enter your card details.
4. Save your changes.

## Remove a payment card

:::warning
Removing your payment card downgrades your plan to Free. Usage beyond the Free allowance stops being available.
:::

1. In the **Payment method** section, click the delete icon next to your card.
2. Confirm the removal.

## Invoices and payments

The **Payments** section lists each billing period with its usage, cost, and status. Pro plans are billed on the first of each month for the previous month's usage. For how charges are calculated, see [Plans](/administration/plans#upgrade-to-pro).

A billing period has one of the following statuses:

- **Paid.** The charge has been settled.
- **Due.** The charge is outstanding.
- **Skipped.** No charge was raised for the period.

To view and download the invoice for a period, click the link icon at the end of its row.

## Next steps

- [Plans](/administration/plans): how Free, Pro, and Enterprise billing works.
- [Usage](/administration/usage): see a detailed breakdown of usage by mode and model.
30 changes: 30 additions & 0 deletions docs/administration/domain-verification.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Domain verification
description: Verify a domain so users from your organization join your workspace automatically.
---

# Domain verification

Once a domain is verified, anyone signing up with an email address on that domain is added to your workspace as a Member. Domain verification requires the Admin role.

## Verify a domain

1. Go to **Manage workspace** in the sidebar under **Workspace**.
2. In the **Domain** section, click **Add domain**.
3. Enter the domain you want to verify.
4. Add the DNS TXT record shown to your domain's DNS settings.
5. Return to the portal and click **Verify**.

DNS propagation can take up to 24 hours. The domain status changes to **Verified** once the record is detected.

## Remove a verified domain

1. In the **Domain** section, click the delete icon next to the verified domain.
2. Confirm the removal.

Removing a domain stops new automatic joins. Existing members keep their access.

## Next steps

- [Manage members](/administration/manage-members): invite users manually or change their roles.
- [Single sign-on (SSO)](/administration/sso): configure SSO for your workspace.
37 changes: 37 additions & 0 deletions docs/administration/manage-members.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Manage members
description: Invite users to your workspace, change their roles, and remove access.
---

# Manage members

Member management requires the Admin role. See [Workspaces concepts](/administration/workspaces-concepts#roles) for what each role can do.

## Invite a user

1. Go to **Manage workspace** in the sidebar under **Workspace**.
2. In the **Users** section, click **Invite user**.
3. Enter the user's email address.
4. Select a role: **Admin** or **Member**.
5. Click **Invite**.

The invited user receives an email with a link to complete their account. Until they accept, they will not appear as an active member.

## Change a user's role

1. In the **Users** table, click the options menu (⋯) next to the user.
2. Select **Edit role**.
3. Choose the new role and confirm.

## Remove a user

Removing a user revokes their access to the workspace immediately. Any API keys they created stay in the workspace and continue to work, because keys belong to the workspace rather than the user. Revoke them separately if needed. See [API keys](/administration/api-keys).

1. In the **Users** table, click the options menu (⋯) next to the user.
2. Select **Remove user**.
3. Confirm the removal.

## Next steps

- [Domain verification](/administration/domain-verification): let users from your organization join automatically.
- [Single sign-on (SSO)](/administration/sso): configure SSO for your workspace.
68 changes: 68 additions & 0 deletions docs/administration/management-tokens.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Management tokens
description: Automate workspace administration with tokens that create projects and manage API keys programmatically.
---

# Management tokens

## How management tokens work

Management tokens authenticate programmatic access to workspace administration. Use them to automate project creation, API key management, and other workspace operations through the Management API.

Tokens are scoped to the workspace and do not expire unless you revoke them. Each token can be assigned a subset of permissions, so you can limit access to only what your automation requires.

### Permissions

| Permission | Description |
|---|---|
| View projects | View projects created within your workspace. |
| Manage projects | Manage, edit, and delete projects in your workspace. |
| View API keys | View API keys generated in your workspace. |
| Delete API keys | Delete API keys in your workspace. |
| Create API key | Create API keys in your workspace. |

## Create a management token

1. Go to **Manage workspace** in the sidebar under **Workspace**.
2. In the **Management tokens** section, click **+ Create management token**.
3. Enter a descriptive name for the token.
4. Select the permissions your automation needs.
5. Click **Create management token**.
6. Copy the token value from the **Save your key** dialog.

:::warning
You cannot access the token value again after closing this dialog. Store it in a secure location immediately.
:::

## View token details

1. In the **Management tokens** table, click the options menu (⋯) next to the token.
2. Select **View details**.

The details panel displays the token name, key prefix, last used timestamp, assigned permissions, and creation date.

## Revoke a management token

Revoking a token disables it immediately. API requests made with the token are rejected, which may break any systems that depend on it.

:::danger
Revoking a management token cannot be undone.
:::

1. In the **Management tokens** table, click the options menu (⋯) next to the token.
2. Select **Revoke key**.
3. Review the token name and key in the confirmation dialog.
4. Click **Revoke key** to confirm.

## Management token best practices

- **Limit permissions.** Assign only the permissions each token needs. A token that creates API keys does not need permission to delete them.
- **Use descriptive names.** Name tokens after their purpose or the system that uses them, such as `ci-pipeline` or `key-rotation-script`. This makes it easier to audit and revoke the right token later.
- **Rotate tokens periodically.** Create a replacement token, update your systems, then revoke the old one.
- **Revoke unused tokens.** Check the **Last used** column regularly. Revoke any token that has never been used or has not been used recently.

## Next steps

- [Create an API key](/api-ref/management/create-an-api-key): Management API reference for creating keys programmatically.
- [Projects](/administration/projects): create and manage projects.
- [API keys](/administration/api-keys): how API keys differ from management tokens.
57 changes: 57 additions & 0 deletions docs/administration/plans.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Plans
description: Understand the Free, Pro, and Enterprise plans and how each one is billed.
---

# Plans

Speechmatics offers two self-serve plans, Free and Pro, plus Enterprise for contract-based usage.

- **Free.** Use Speechmatics up to a monthly allowance at no cost.
- **Pro.** Pay-as-you-go billing beyond the Free allowance, with volume and model training discounts.
- **Enterprise.** A contract-based plan with dedicated support and deployment options beyond the cloud. See [Enterprise](#enterprise).

Prices are not listed here. For current rates, see the [Speechmatics pricing page](https://www.speechmatics.com/pricing).

## Upgrade to Pro

To upgrade from Free to Pro, add a payment card on the Billing page. See [Billing](/administration/billing).

Pro plans are billed on the first of each month for the previous month's usage. Charges are calculated to the exact second, based on the per-hour rate for each product type. Pro usage is capped at 6,000 hours per month.

## Discounts

Pro plans can access two discounts, which can be applied at the same time.

### Model training discount

Enable **Model training** to receive a 33% discount on your usage. Model training, also called data logging, lets Speechmatics use anonymized data to improve its models and services. You can change this setting at any time, and it applies to future usage only.

Enable **Model training** in **Manage workspace**.

### Volume discount

A 20% volume discount applies automatically to billable usage above 500 hours per month, for each Speech to Text product type (a combination of processing mode and model, such as Realtime Enhanced).

For example, if in one month you use 800 hours of Realtime Enhanced and 400 hours of Realtime Standard, you are billed as:

- 500 hours of Realtime Enhanced at the base rate
- 300 hours of Realtime Enhanced at the 20% discount
- 400 hours of Realtime Standard at the base rate

## Enterprise

Enterprise is a contract-based plan for organizations that need dedicated support or deployment options beyond the cloud. It is separate from the self-serve Free and Pro plans: billing is handled through a contract rather than pay-as-you-go, with no payment card or monthly portal billing.

Enterprise includes:

- **High-touch support.** Dedicated customer support, onboarding, and solutions engineering.
- **On-prem and on-device deployment.** These deployment options are available only on Enterprise. See [Deployments](/deployments/).
- The best available discounts and early access to new features.

To discuss an Enterprise plan, [contact sales](https://www.speechmatics.com/speak-to-sales).

## Next steps

- [Billing](/administration/billing): add a payment card, and view invoices and payments.
- [Usage](/administration/usage): track the hours that determine your charges.
Loading