Skip to content

docs: add Eden AI integration guides for Bifrost and Lynkr (AI Gateway)#70

Closed
MVS-source wants to merge 1 commit into
mainfrom
integrations/ai-gateway-bifrost-lynkr
Closed

docs: add Eden AI integration guides for Bifrost and Lynkr (AI Gateway)#70
MVS-source wants to merge 1 commit into
mainfrom
integrations/ai-gateway-bifrost-lynkr

Conversation

@MVS-source

@MVS-source MVS-source commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

What

Two new integration guides, grouped under a new AI Gateway nav section:

Guide Type Integration path
Bifrost OpenAI-compatible LLM gateway (Go) Custom Provider in config.json, no fork/build
Lynkr Tier-based routing gateway Eden AI is a built-in provider

Both route to Eden AI's OpenAI-compatible V3 API (https://api.edenai.run/v3) for access to 500+ models behind one key.

Files

  • v3/integrations/bifrost.mdx (new)
  • v3/integrations/lynkr.mdx (new)
  • integration-logo/bifrost-icondoc.svg, lynkr-icondoc.svg (new, square marks)
  • docs.json — new AI Gateway group (icon network-wired) with both pages

Conventions

  • Format matches existing integration docs (<TechArticleSchema> + <CodeGroup>).
  • Env var: EDEN_AI_API_KEY (house style) for Bifrost; EDENAI_API_KEY for Lynkr since it derives the name from the provider (<PROVIDER>_API_KEY).

To confirm before merge

  • Bifrost custom_provider_config.allowed_requests keys (chat_completion / embedding) against the current Bifrost schema.
  • Lynkr TIER_* variable names and default port (8081).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added an AI Gateway section to the V3 Integrations documentation.
    • Added integration guides for Bifrost and Lynkr, including installation, configuration, routing options, environment variables, model examples, and API usage.
    • Included links to related endpoint and SDK documentation for next steps.

Add two new integration guides under a new "AI Gateway" nav group:

- Bifrost: OpenAI-compatible LLM gateway (Custom Provider config)
- Lynkr: tier-based routing gateway (built-in Eden AI provider)

Both point at https://api.edenai.run/v3. Env var follows the docs
house style (EDEN_AI_API_KEY) for Bifrost; Lynkr uses its derived
EDENAI_API_KEY (<PROVIDER>_API_KEY convention). Includes square icon
SVGs and docs.json nav entries.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Added Bifrost and Lynkr integration documentation, including setup, configuration, routing, models, environment variables, metadata, and navigation under a new V3 AI Gateway group.

Changes

AI Gateway documentation

Layer / File(s) Summary
Bifrost integration guide
v3/integrations/bifrost.mdx
Documents Bifrost installation, Eden AI provider configuration, requests, runtime setup, models, routing, environment variables, and next steps.
Lynkr integration guide
v3/integrations/lynkr.mdx
Adds Lynkr installation, quick-start, environment, routing, provider model, and next-step documentation with structured metadata.
AI Gateway navigation wiring
docs.json
Adds a collapsed AI Gateway group linking to the Bifrost and Lynkr pages.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • edenai/docs#32: Adds a related V3 Integrations documentation page and navigation entry.

Poem

A rabbit hops through docs so bright,
With gateways tucked beneath the light.
Bifrost routes and Lynkr sings,
Models bloom on helpful wings.
Two new trails for seekers to roam—
AI guidance now has a home!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the added Eden AI integration guides for Bifrost and Lynkr.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch integrations/ai-gateway-bifrost-lynkr

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

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
edenai 🟢 Ready View Preview Jul 16, 2026, 1:39 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
v3/integrations/bifrost.mdx (1)

107-107: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Use standardized token placeholders.

As per coding guidelines, "Distinguish token types in code examples: api_token for production and sandbox_api_token for testing (no real provider calls)". Please update these environment variables to use the standardized placeholder.

  • v3/integrations/bifrost.mdx#L107-L107: Replace your_api_key_here with api_token.
  • v3/integrations/lynkr.mdx#L51-L51: Replace your-edenai-key with api_token.
  • v3/integrations/lynkr.mdx#L72-L72: Replace your-edenai-key with api_token.
  • v3/integrations/lynkr.mdx#L124-L124: Replace your_api_key_here with api_token.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@v3/integrations/bifrost.mdx` at line 107, Standardize the token placeholders
in v3/integrations/bifrost.mdx lines 107-107 and v3/integrations/lynkr.mdx lines
51-51, 72-72, and 124-124 by replacing each provider-specific or generic
placeholder with api_token; no other changes are needed.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@v3/integrations/lynkr.mdx`:
- Around line 93-96: Update the Lynkr environment variable definitions so the
existing TIER_HARD and TIER_EXPERT entries are renamed to TIER_COMPLEX and
TIER_REASONING, respectively, while preserving their current model assignments
and the TIER_SIMPLE and TIER_MEDIUM entries.

---

Nitpick comments:
In `@v3/integrations/bifrost.mdx`:
- Line 107: Standardize the token placeholders in v3/integrations/bifrost.mdx
lines 107-107 and v3/integrations/lynkr.mdx lines 51-51, 72-72, and 124-124 by
replacing each provider-specific or generic placeholder with api_token; no other
changes are needed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3f32cdb5-14a9-4a55-adcb-c0476326e739

📥 Commits

Reviewing files that changed from the base of the PR and between 5174e81 and 1592b2d.

⛔ Files ignored due to path filters (2)
  • integration-logo/bifrost-icondoc.svg is excluded by !**/*.svg
  • integration-logo/lynkr-icondoc.svg is excluded by !**/*.svg
📒 Files selected for processing (3)
  • docs.json
  • v3/integrations/bifrost.mdx
  • v3/integrations/lynkr.mdx

Comment thread v3/integrations/lynkr.mdx
Comment on lines +93 to +96
export TIER_SIMPLE=edenai:mistral/mistral-small-latest
export TIER_MEDIUM=edenai:openai/gpt-4o-mini
export TIER_HARD=edenai:anthropic/claude-sonnet-4-5
export TIER_EXPERT=edenai:openai/gpt-4o

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🌐 Web query:

What are the tier-based routing environment variables (e.g., TIER_SIMPLE, TIER_MEDIUM) used in the Lynkr LLM gateway?

💡 Result:

In the Lynkr LLM gateway, tier-based routing is configured using four mandatory environment variables [1][2]. When all four are defined, Lynkr scores incoming requests for complexity (on a scale of 0-100) and routes them to the specific provider and model assigned to that tier [1][3]. The four required tier-based routing environment variables are: - TIER_SIMPLE: Used for simple tasks (complexity score 0-25) [1][4]. - TIER_MEDIUM: Used for medium-complexity tasks (complexity score 26-50) [1][4]. - TIER_COMPLEX: Used for complex tasks (complexity score 51-75) [1][4]. - TIER_REASONING: Used for highly complex or reasoning-intensive tasks (complexity score 76-100) [1][4]. These variables must be set in the format provider:model (e.g., TIER_SIMPLE=ollama:llama3.2) [1][2]. Important configuration details: - Activation: All four variables must be set simultaneously to enable tiered routing [1][5]. If any variable is missing, tiered routing is disabled, and the system defaults to the provider specified in the MODEL_PROVIDER variable [3][5]. - Priority: When all four are correctly configured, they override the MODEL_PROVIDER for routing decisions [2][4]. - Fallback: The MODEL_PROVIDER variable must still be set, as it is used for system startup checks and as a default provider in specific edge cases [2][5]. Lynkr supports various providers, including ollama, openai, azure-openai, openrouter, databricks, bedrock, vertex, zai, moonshot, llamacpp, and lmstudio [6][2].

Citations:


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '--- file outline ---\n'
ast-grep outline v3/integrations/lynkr.mdx --view expanded || true

printf '\n--- relevant file excerpt ---\n'
sed -n '1,180p' v3/integrations/lynkr.mdx

printf '\n--- search for tier env vars in repo ---\n'
rg -n "TIER_(SIMPLE|MEDIUM|COMPLEX|REASONING|HARD|EXPERT)|MODEL_PROVIDER|routing" v3 documentation . -g '!**/node_modules/**' || true

Repository: edenai/docs

Length of output: 240


🌐 Web query:

Lynkr routing documentation TIER_SIMPLE TIER_MEDIUM TIER_COMPLEX TIER_REASONING environment variables

💡 Result:

In Lynkr, the TIER_SIMPLE, TIER_MEDIUM, TIER_COMPLEX, and TIER_REASONING environment variables are used to enable and configure tier-based routing [1][2][3]. When all four variables are set, Lynkr scores incoming requests for complexity (0–100) and automatically routes them to the provider and model specified for the matching tier [1][2][3]. Key details for these variables include: Configuration Requirements: - Format: You must use the provider:model format (e.g., TIER_SIMPLE=ollama:llama3.2) [1][3][4]. - Activation: All four variables must be defined to activate tier-based routing [2][5][3]. If any variable is missing, tier-based routing is disabled, and Lynkr defaults to using the provider defined in the MODEL_PROVIDER environment variable [2][5][3]. - Precedence: When active, these variables override the standard MODEL_PROVIDER setting for routing decisions [2][5][6]. Tier Complexity Mapping: Requests are scored on a scale of 0–100 and mapped to the tiers as follows [2][6]: - TIER_SIMPLE (0–25) - TIER_MEDIUM (26–50) - TIER_COMPLEX (51–75) - TIER_REASONING (76–100) Additional Considerations: - MODEL_PROVIDER: Even when tier-based routing is active, the MODEL_PROVIDER variable remains required for internal processes, such as startup checks, provider discovery, and as a fallback if a tier variable lacks a provider prefix [5][3]. - Fallback: You can also configure a FALLBACK_PROVIDER to handle cases where a chosen tier provider fails [2][6][7]. - Setup: It is recommended to configure these in your.env file using plain KEY=VALUE syntax without an export prefix [8][4].

Citations:


Use Lynkr’s documented tier names. TIER_HARD and TIER_EXPERT should be TIER_COMPLEX and TIER_REASONING; Lynkr expects TIER_SIMPLE, TIER_MEDIUM, TIER_COMPLEX, and TIER_REASONING.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@v3/integrations/lynkr.mdx` around lines 93 - 96, Update the Lynkr environment
variable definitions so the existing TIER_HARD and TIER_EXPERT entries are
renamed to TIER_COMPLEX and TIER_REASONING, respectively, while preserving their
current model assignments and the TIER_SIMPLE and TIER_MEDIUM entries.

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
edenai 🟡 Building Jul 16, 2026, 1:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@MVS-source

Copy link
Copy Markdown
Collaborator Author

Remplacée par #73 (historique de commits nettoyé, même contenu).

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.

2 participants