docs(haystack-router): add free tier API key to all examples#4
Merged
Conversation
Replace placeholder `'your-api-key'` values with the free tier key (`1b72df7e-1131-4449-8ce1-29b79dd3f51e`) across all haystack-router skill files. This reflects the free tier added in TxnLab/haystack-js#8. - Add API Key Tiers section to configuration.md with free/production tiers - Update SKILL.md to mention the free key and link to configuration.md - Remove "API key — request from support" prerequisite from getting-started.md - Replace all placeholder keys in code examples across 7 reference files - Update .env example in node-automation.md with the free tier key Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
'your-api-key'values with the free tier API key across haystack-router skill files, reflecting the free tier added in TxnLab/haystack-js#8Changes
SKILL.md — Updated the API key callout to mention the free tier key and link to configuration.md for details. Replaced the placeholder in the core flow example.
references/configuration.md — Added a new API Key Tiers section at the top with a table (Free:
1b72df7e-..., 60 req/min, no registration; Production: request from support@txnlab.dev). Replaced all 8 placeholder keys in code examples throughout.references/getting-started.md — Removed "API key — request from support@txnlab.dev" from prerequisites. Updated all 4 RouterClient examples to use the free tier key.
references/quotes.md — Updated 2 RouterClient examples.
references/swaps.md — Updated 2 RouterClient examples.
references/fees-and-referrals.md — Updated 2 RouterClient examples.
references/node-automation.md — Updated the
.envexample to use the free tier key.Test plan
bun run dev validate haystack-routerpassesbun run lintpasses'your-api-key'placeholders in haystack-router files