client snippet update

[nikbhintade]

HyperSync client now accepts API tokens from the apiToken or api_token field. The Python client is not updated yet, so it still uses the bearer_token field.

Summary by CodeRabbit

• Documentation
  • Updated API token usage documentation and code examples across TypeScript, Python, and Rust
  • Revised environment variable naming conventions for API token configuration to ensure consistency

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

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

Project	Deployment	Review	Updated (UTC)
envio-docs	Ready	Preview, Comment	Dec 26, 2025 7:35am

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update standardizing API token naming across HyperSync examples. Replaces bearer_token parameter and HYPERSYNC_BEARER_TOKEN environment variable with api_token and ENVIO_API_TOKEN respectively in TypeScript, Python, and Rust code snippets.

Changes

Cohort / File(s)	Summary
HyperSync API Token Documentation docs/HyperSync/api-tokens.mdx	Updated parameter naming from bearer_token to api_token and environment variable from HYPERSYNC_BEARER_TOKEN to ENVIO_API_TOKEN across all language examples (TypeScript, Python, Rust).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• add token example #690 — Updates documentation to use the same ENVIO_API_TOKEN naming convention across multiple doc sections.
• Update messaging around tokens (RFC) #719 — Modifies the same docs/HyperSync/api-tokens.mdx file with related API token naming and environment variable updates.

Suggested labels

codex

Suggested reviewers

• DZakh
• JasoonS
• Piroddi

Poem

🐰 Token names unified with grace,
From bearer's old to api's place,
ENVIO_API_TOKEN shines so bright,
Across all tongues—TypeScript, Python's light,
Consistency hops through every line! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'client snippet update' is vague and generic, using non-descriptive language that doesn't convey the specific nature of the changes (API token parameter renaming across documentation examples).	Consider a more specific title like 'Update API token parameter names in client examples' or 'Replace bearer_token with api_token in HyperSync documentation' to better reflect the actual changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch nb/hypersync-api-key-update

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68a8d34 and 6ab2790.

📒 Files selected for processing (1)

• docs/HyperSync/api-tokens.mdx

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/HyperSync/api-tokens.mdx (1)

37-70: Update line 37 to clarify parameter naming differences across languages, and verify consistency with other Rust implementations.

Line 37 states "pass it as a bearer_token" but the examples use three different parameter names: apiToken (TypeScript), bearer_token (Python), and api_token (Rust). Additionally, other documentation files use bearer_token for Rust (e.g., HyperFuel), creating inconsistency in the Rust client API across the docs.

Recommend either:

1. Updating line 37 to note that parameter names differ by language and explaining why, or
2. Verifying that the Rust parameter should be api_token or bearer_token and aligning all Rust examples across the documentation

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68a8d34 and 6ab2790.

📒 Files selected for processing (1)

• docs/HyperSync/api-tokens.mdx

[DZakh]

Thanks