Skip to content

docs: clarify service keys vs admin tokens for actor management#4422

Open
NathanFlurry wants to merge 1 commit intomainfrom
fix-cloud-token-docs
Open

docs: clarify service keys vs admin tokens for actor management#4422
NathanFlurry wants to merge 1 commit intomainfrom
fix-cloud-token-docs

Conversation

@NathanFlurry
Copy link
Member

Summary

Fix incorrect guidance in actor management documentation by clarifying the difference between service keys (for Rivet Cloud) and admin tokens (for self-hosted):

  • Replace confusing "admin token" and "Cloud API token" language with accurate guidance
  • Rivet Cloud uses service keys (sk_*) from RIVET_ENDPOINT
  • Self-hosted deployments use admin tokens
  • Add GET /actors endpoint example for discovering actor IDs before destroying
  • Remove dead-end notes about unsupported admin tokens

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

Files changed

  • website/src/content/docs/actors/debugging.mdx – Runner API auth guidance
  • website/src/content/docs/actors/destroy.mdx – HTTP destroy and listing endpoints

Replace confusing 'admin token' and 'Cloud API token' language with accurate guidance:
- Rivet Cloud uses service keys (sk_*) from RIVET_ENDPOINT
- Self-hosted uses admin tokens
- Add GET /actors endpoint example for listing actors before destroying
- Remove dead-end notes about unsupported admin tokens
@railway-app
Copy link

railway-app bot commented Mar 13, 2026

🚅 Deployed to the rivet-pr-4422 environment in rivet-frontend

Service Status Web Updated (UTC)
website 😴 Sleeping (View Logs) Web Mar 13, 2026 at 10:04 pm
frontend-cloud 😴 Sleeping (View Logs) Web Mar 13, 2026 at 10:02 pm
frontend-inspector 😴 Sleeping (View Logs) Web Mar 13, 2026 at 9:57 pm
mcp-hub ✅ Success (View Logs) Web Mar 13, 2026 at 9:52 pm
ladle ❌ Build Failed (View Logs) Web Mar 13, 2026 at 9:51 pm

@claude
Copy link

claude bot commented Mar 13, 2026

PR Review - Overall LGTM

This is a straightforward documentation fix that corrects inaccurate auth guidance.

What is good:

  • Correct auth distinction: The old docs conflated Cloud API token with the actual mechanism used. The new guidance correctly separates Rivet Cloud (service keys from RIVET_ENDPOINT) vs self-hosted (admin tokens).
  • Practical example format: The service key extraction hint showing the sk_* portion of the endpoint URL is helpful for users who may not know where to find it.
  • Added GET /actors listing example: Adding the list endpoint as a prerequisite step for finding actor IDs before destroying is a nice UX improvement.
  • Removed dead-end note: The old Note block pointed to a Cloud API Tokens flow that does not apply. Removing it avoids sending users down the wrong path.

Minor suggestions:

  1. Placeholder style consistency: debugging.mdx uses shell variable placeholders while destroy.mdx uses curly-brace placeholders. Pre-existing inconsistency, worth aligning in a future docs pass.
  2. List endpoint is bash-only: The new GET /actors snippet is bash-only, while the DELETE section has both TypeScript and bash examples. Users working from the TypeScript example may still be stuck finding actor IDs. Minor.
  3. Dashboard nav path: Worth verifying the Settings path matches the actual current dashboard UI, since nav labels can drift from docs over time.

None of these are blockers. The core fix is correct and improves the developer experience.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 13, 2026

More templates

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/cloudflare-workers@4422

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/framework-base@4422

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/next-js@4422

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/react@4422

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivet/rivetkit@4422

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sql-loader@4422

@rivetkit/sqlite-vfs

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sqlite-vfs@4422

@rivetkit/traces

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/traces@4422

@rivetkit/workflow-engine

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/workflow-engine@4422

@rivetkit/virtual-websocket

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/virtual-websocket@4422

@rivetkit/engine-runner

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner@4422

@rivetkit/engine-runner-protocol

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner-protocol@4422

commit: 80934b5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant