Skip to content

[REMOTE-1777] Update API key docs for Agent API keys#141

Draft
seemeroland wants to merge 1 commit into
mainfrom
oz-agent/REMOTE-1777-agent-api-key-docs
Draft

[REMOTE-1777] Update API key docs for Agent API keys#141
seemeroland wants to merge 1 commit into
mainfrom
oz-agent/REMOTE-1777-agent-api-key-docs

Conversation

@seemeroland
Copy link
Copy Markdown

Summary

  • Update Oz API key docs to describe Agent API keys as the current automation model
  • Document that Default Service Account Agent API keys are equivalent to old team API keys
  • Refresh self-hosting, GitHub authorization, billing, and troubleshooting references from team API keys to Agent API keys

Testing

  • npm run typecheck
  • npm run build

This PR was created by Oz (running Codex).

Co-Authored-By: Oz <oz-agent@warp.dev>
@seemeroland seemeroland added the from-feedback-bot PR originated from Feedback Bot delegated Linear issue label May 26, 2026
@cla-bot cla-bot Bot added the cla-signed label May 26, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 26, 2026 7:14pm

Request Review

hongyi-chen added a commit that referenced this pull request May 26, 2026
After auditing PR #141 (parallel Codex run for REMOTE-1777), extend the
sweep to the files that still said 'team API key' in places where the
phrase should also acknowledge agent identity / Default Service Account
keys created in the Oz web app. The Warp desktop app continues to label
its key type 'Team' (and Jason is reverting NamedAgents in the client
so it stays that way), so the wording becomes 'team or agent API key'
rather than a pure rename.

Touched files:
- agent-platform/cloud-agents/agents.mdx
- agent-platform/cloud-agents/team-access-billing-and-identity.mdx
- agent-platform/cloud-agents/environments.mdx
- agent-platform/cloud-agents/quickstart.mdx
- agent-platform/cloud-agents/self-hosting/reference.mdx
- enterprise/team-management/admin-panel.mdx
- enterprise/support-and-resources/billing.mdx
- reference/cli/integration-setup.mdx
- reference/api-and-sdk/troubleshooting/errors/external-authentication-required.mdx
- reference/api-and-sdk/troubleshooting/errors/insufficient-credits.mdx
- support-and-community/plans-and-billing/credits.mdx
- support-and-community/plans-and-billing/add-on-credits.mdx
- support-and-community/plans-and-billing/pricing-faqs.mdx

agents.mdx also gains the explicit 'Default Service Account' callout
and the Warp-app-Team / Oz-web-app-Agent equivalence note.

Co-Authored-By: Oz <oz-agent@warp.dev>
Copy link
Copy Markdown
Collaborator

👋 Heads up — I'm a parallel Oz agent run (Claude Opus) on the same REMOTE-1777 ticket, working out of PR #143. We came at the same problem from different angles. Posting an audit in case it's useful for whoever ends up merging.

Where this PR is stronger than #143:

  • Broader file sweep (21 files vs. my 10). I've since extended docs: cover Personal / Team / Agent API key types #143 to cover the same billing, GitHub-auth, and error-doc files in the second commit on that branch.
  • Crisper framing on agents.mdx ("called Default Service Account" + equivalence note) — I borrowed that idea.

Where I think this PR is incorrect:

  1. Warp desktop app prereqs tell users to create an "Agent API key" there, but warp-internal/app/src/settings_view/platform/create_api_key_modal.rs only shows the Agent option when FeatureFlag::NamedAgents is on. Jason confirmed in the ext-warp-phantom Slack thread that he's reverting that flag, so the Warp desktop app's modal will show Personal | Team for everyone. Customers following these prereqs in the Warp app won't find an "Agent" option.
  2. api-keys.mdx drops the Personal key type entirely from the create flow and substitutes oz login for personal API key references. oz login is interactive browser auth — not a headless replacement for a personal API key. Personal keys still exist and are explicitly required by some surfaces (e.g., the Enterprise Analytics API explicitly rejects team keys).
  3. The Managing API keys section changes the Scope column from "Personal or Team" to "Agent" — that loses the Personal scope, which is still a valid scope users will see.

PR #143 keeps the trichotomy (Personal / Team / Agent), documents the per-surface UI difference (Oz web app shows Personal/Agent; Warp app shows Personal/Team), and frames Default Service Account Agent keys as functionally identical to the old Team keys.

Both PRs build cleanly and pass CI. Coordinating with @hongyi-chen / the docs owners on which one to merge — happy to pull anything from this PR I missed.

Posted by Oz (Claude Opus run) on a separate REMOTE-1777 work item.

Copy link
Copy Markdown
Collaborator

Update: PR #143 has been restructured per @killian's feedback to address the team→agent rename holistically — it now uses "agent API key" throughout the docs (no dual "team or agent" wording) with a single naming-change disclaimer at the top of api-keys.mdx that explains the rename and notes the Warp desktop app's legacy "Team" label.

This means PR #143 now covers the same surface area as this PR (23+ files) with the same forward-looking framing you set up here, plus the broken-link fix in github-actions.mdx. Recommend closing this PR in favor of #143; happy to merge in any specific wording from this PR if you'd like before that.

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

Labels

cla-signed from-feedback-bot PR originated from Feedback Bot delegated Linear issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants