Skip to main content

Bytes API

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

The public Developer API is the /api/v1/* API. It is authenticated with a workspace API key and is designed for server-side integrations.

Current Beta scope

The current public Developer API is intentionally small. It supports creating, listing, reading, updating and archiving links, managing workspace tags and attaching tags to links.

Only the endpoints listed on this page are public Developer API endpoints. Undocumented dashboard APIs are not supported for external integrations.

API base URL

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

Current public endpoints

MethodPathPurpose
GET/linksList workspace links
POST/linksCreate a short link
GET/links/{id}Read one short link
PATCH/links/{id}Update one short link
DELETE/links/{id}Archive one short link
GET/tagsList workspace tags
POST/tagsCreate a workspace tag
PATCH/tags/{id}Update a workspace tag
DELETE/tags/{id}Delete a workspace tag
POST/links/{id}/tagsAttach one or more tags to a link
DELETE/links/{id}/tags/{tagId}Remove a tag from a link

CLI

For repeatable workflows, scripts and local developer tasks, install the Bytes CLI:

npm install -g @jawwws/bytes-cli

Then configure it with a workspace API key:

bytes config set-api-key YOUR_BYTES_API_KEY
bytes links list

See the CLI guide for commands and examples.

Where to create an API key

In your Bytes dashboard, go to:

Workspace Settings -> Developer API

Each API key belongs to one workspace. A key can only act inside that workspace.

Storing your key safely

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

BYTES_API_KEY=YOUR_BYTES_API_KEY
BYTES_API_BASE_URL=https://api.jaww.ws/api/v1
Never expose API keys

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
  • include real API keys in screenshots
  • share one key between unrelated systems

Make your first request

Create your first link with the getting started guide.

What is not public Developer API yet?

The Bytes app uses additional browser-session APIs for dashboard features. Those are not public Developer API endpoints.

Do not build external integrations against undocumented dashboard routes. They use session authentication, may require workspace context headers and can change as the dashboard evolves.

Future public API areas will be added here only when deliberate /api/v1/* endpoints exist and are ready for external developers.