Skip to main content

API Keys

API keys let applications access Scriptix programmatically, without a user login. This guide covers creating, managing, and using them.

Token types​

  • Batch: store audio first, then process it (upload files, retrieve results later).
  • Realtime: process audio as it streams in.

Access​

Open the API Keys page from the menu. You need the DEVELOPER role to view it. Deleting tokens requires the ADMIN or DEVELOPER role.

Create a token​

  1. Click Add Token.
  2. Enter a descriptive name (for example, "Production integration").
  3. Choose a type: Batch or Realtime.
  4. Choose an expiration period: 1 year (recommended), 2 years, or 5 years.
  5. Click Create.

The full token value is shown once, immediately after creation. Copy it and store it securely. You cannot retrieve it later. If you lose it, delete the token and create a new one.

Manage tokens​

The token list shows each token's ID, name, shortened key, type, and expiration date. Use the copy icon to copy a token value.

Token name, type, and expiration cannot be changed after creation. To change any of them, delete the token and create a new one.

Delete a token​

  1. Click the delete (trash) action on the token row.
  2. Confirm in the dialog.

Deletion is immediate and permanent. Any API requests using the token stop working right away.

Use a token​

Send the token as a Bearer token in the Authorization header of every request:

Authorization: Bearer YOUR_TOKEN_HERE

Create a token via the API​

POST /api/v3/tokens
{
  "name": "Production integration",
  "type": "batch",
  "years_valid": 1
}

The response includes the full token value. This is the only time it is returned.

Next steps​