Skip to main content

Bytes API

The Bytes API lets you connect your workspace to your own websites, applications, internal tools, and automation workflows.

You can use the API to automate tasks such as creating short links for your workspace. Future releases will add support for retrieving analytics, managing campaigns, and building reporting integrations.

Where to find it​

In your Bytes dashboard, go to:

Workspace Settings → API

API base URL​

https://api.jaww.ws/api/v1

API keys​

API keys allow your systems to authenticate with Bytes. Each key belongs to your workspace. You can create separate keys for different systems or integrations, for example:

Production website backend
Monthly reporting script
Campaign automation
Zapier or Make workflow

Using separate keys makes it easy to revoke one integration without affecting the others.

Creating an API key​

  1. Open Workspace Settings → API
  2. Select Create API key
  3. Enter a clear, descriptive name for the key
  4. Select Create API key
  5. Copy the key immediately
  6. Store it securely
One-time reveal

When you create an API key, Bytes will show the full key only once.

Copy it immediately and store it securely. After you leave the reveal screen, you will not be able to view the full key again.

If you lose a key, revoke it and create a new one.

Storing your key safely​

Store your API key in an environment variable or secrets manager, never in your source code.

BYTES_API_KEY=jb_live_xxx
BYTES_API_BASE_URL=https://api.jaww.ws/api/v1
Never commit API keys to source control

Do not:

  • Commit API keys to GitHub, GitLab, or any source repository
  • Paste API keys into support tickets or chat messages
  • Put API keys directly into frontend or browser code
  • Share a single key between unrelated systems

Making your first request​

curl https://api.jaww.ws/api/v1/links \
  -H "Authorization: Bearer jb_live_xxx"

Replace jb_live_xxx with the API key you copied when creating the key.

For a full walkthrough from account to first API response, see the getting started guide.

Revoking an API key​

Revoke a key when:

  • You no longer use the integration
  • A developer, contractor, or agency no longer needs access
  • You think the key may have been exposed
  • You are rotating credentials as part of a security review

When a key is revoked, any system using that key will stop working immediately.

Use clear, specific names so you always know what a key is used for.

Good examples:

Production website backend
Monthly reporting script
Print campaign QR automation
Internal dashboard

Avoid vague names:

Test
Key 1
API
New key

Review your keys regularly. Revoke unused keys and create new ones where needed.

Future developer tools​

Bytes will later add SDKs, CLI tools, and webhooks to support more complex workflows.

Possible future CLI:

bytes login
bytes whoami
bytes links create https://example.com/landing --slug summer-campaign
bytes links stats summer-campaign
bytes qr generate summer-campaign --output ./qr.png

Possible future SDK:

import { Bytes } from "@jawwws/bytes";

const bytes = new Bytes({
  apiKey: process.env.BYTES_API_KEY,
});

await bytes.links.create({
  destinationUrl: "https://example.com/landing",
  slug: "summer-campaign",
});

Troubleshooting​

I lost my API key​

You cannot view it again. Revoke the lost key and create a new one.

My integration stopped working​

Check whether the key has been revoked. If it has, create a new key and update your integration.

Can I use an API key in frontend JavaScript?​

No. API keys must be kept in a secure server-side environment. Do not expose them in browser code.

Can I create more than one key?​

Yes. Creating separate keys for different systems is recommended.

What happens when I revoke a key?​

The key stops working immediately. Any systems using it will need to be updated with a new key.

Last updated on