docs: add GitHub Copilot integration page#58
Conversation
Guide for using Eden AI as the model provider for GitHub Copilot via its Bring Your Own Key (BYOK) support: VS Code Custom Endpoint, the Copilot CLI environment variables, and org-wide Enterprise BYOK. Calls out that inline completions / semantic search stay on GitHub's infrastructure. Registered in the Coding Agents nav group. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
WalkthroughA new MDX documentation page ( ChangesGitHub Copilot BYOK Integration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/github-copilot.mdx`:
- Around line 101-102: Replace the custom placeholder `YOUR_EDEN_AI_API_KEY` in
the environment variable export statements with the guideline-compliant token
placeholders: use `api_token` for production examples and `sandbox_api_token`
for testing examples. Additionally, ensure any curl examples that include
authentication headers use the exact format `Authorization: Bearer <api_key>` as
per the documentation guidelines. Apply these changes consistently across all
occurrences at lines 101-102, 108-109, and 157.
- Line 164: The documentation at line 164 references the models catalog endpoint
using a relative path format `GET /v3/models`. Update this reference to use the
full absolute URL format `https://api.edenai.run/v3/models` to maintain
consistency with v3 endpoint documentation guidelines. This applies to all
references to the models endpoint in the github-copilot.mdx file.
🪄 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: 10bdec2a-3649-4021-979c-2f217cc3d458
📒 Files selected for processing (2)
docs.jsonv3/integrations/github-copilot.mdx
| export COPILOT_PROVIDER_API_KEY="YOUR_EDEN_AI_API_KEY" | ||
| export COPILOT_MODEL="anthropic/claude-sonnet-4-5" |
There was a problem hiding this comment.
Use guideline-compliant token/header placeholders in code examples.
Replace YOUR_EDEN_AI_API_KEY with the prescribed token placeholders (api_token for production, sandbox_api_token for testing) and use the exact auth header placeholder format Authorization: Bearer <api_key> in the curl example.
Suggested doc patch
-export COPILOT_PROVIDER_API_KEY="YOUR_EDEN_AI_API_KEY"
+export COPILOT_PROVIDER_API_KEY="api_token"
@@
-$env:COPILOT_PROVIDER_API_KEY = "YOUR_EDEN_AI_API_KEY"
+$env:COPILOT_PROVIDER_API_KEY = "api_token"
@@
- -H "Authorization: Bearer YOUR_EDEN_AI_API_KEY" \
+ -H "Authorization: Bearer <api_key>" \As per coding guidelines, “Use Authorization: Bearer <api_key> header format” and “Distinguish token types in code examples: api_token for production and sandbox_api_token for testing.”
Also applies to: 108-109, 157-157
🤖 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/github-copilot.mdx` around lines 101 - 102, Replace the
custom placeholder `YOUR_EDEN_AI_API_KEY` in the environment variable export
statements with the guideline-compliant token placeholders: use `api_token` for
production examples and `sandbox_api_token` for testing examples. Additionally,
ensure any curl examples that include authentication headers use the exact
format `Authorization: Bearer <api_key>` as per the documentation guidelines.
Apply these changes consistently across all occurrences at lines 101-102,
108-109, and 157.
Source: Coding guidelines
|
|
||
| ### Model not found | ||
|
|
||
| Use the full `provider/model` string (e.g. `anthropic/claude-sonnet-4-5`, not `claude-sonnet-4-5`). Confirm the ID is in the catalog returned by `GET /v3/models`. |
There was a problem hiding this comment.
Use the full v3 endpoint format in the model-catalog reference.
GET /v3/models should be documented in the required absolute format (https://api.edenai.run/v3/...) to stay consistent with v3 endpoint guidance.
Suggested doc patch
-Use the full `provider/model` string (e.g. `anthropic/claude-sonnet-4-5`, not `claude-sonnet-4-5`). Confirm the ID is in the catalog returned by `GET /v3/models`.
+Use the full `provider/model` string (e.g. `anthropic/claude-sonnet-4-5`, not `claude-sonnet-4-5`). Confirm the ID is in the catalog returned by `GET https://api.edenai.run/v3/models`.As per coding guidelines, “Use API endpoint format https://api.edenai.run/v3/... for LLM endpoints.”
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Use the full `provider/model` string (e.g. `anthropic/claude-sonnet-4-5`, not `claude-sonnet-4-5`). Confirm the ID is in the catalog returned by `GET /v3/models`. | |
| Use the full `provider/model` string (e.g. `anthropic/claude-sonnet-4-5`, not `claude-sonnet-4-5`). Confirm the ID is in the catalog returned by `GET https://api.edenai.run/v3/models`. |
🤖 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/github-copilot.mdx` at line 164, The documentation at line
164 references the models catalog endpoint using a relative path format `GET
/v3/models`. Update this reference to use the full absolute URL format
`https://api.edenai.run/v3/models` to maintain consistency with v3 endpoint
documentation guidelines. This applies to all references to the models endpoint
in the github-copilot.mdx file.
Source: Coding guidelines
1 participant
What
Adds an integration guide for using Eden AI as the model provider for GitHub Copilot via Copilot's Bring Your Own Key (BYOK) support.
Paths covered:
chatLanguageModels.jsonCOPILOT_PROVIDER_*environment variablesNotes
https://api.edenai.run/v3/chat/completions(provider/model, bearer auth).maintemplate (TechArticleSchemasnippet import); registered in the Coding Agents nav group.github) — swap in a brand SVG at/integration-logo/github-copilot-icondoc.svgwhen available.Sources: VS Code BYOK docs, GitHub Copilot CLI BYOK docs.
🤖 Generated with Claude Code
Summary by CodeRabbit