Skip to content

Commit 5c897c2

Browse files
authored
Merge pull request #618 from Portkey-AI/migration/04-ai-tools
Model Catalog Migration 4/7: AI Tools & Apps
2 parents c8bb868 + 2c629fe commit 5c897c2

24 files changed

Lines changed: 1793 additions & 8057 deletions

integrations/libraries/anythingllm.mdx

Lines changed: 41 additions & 398 deletions
Large diffs are not rendered by default.

integrations/libraries/claude-code.mdx

Lines changed: 38 additions & 382 deletions
Large diffs are not rendered by default.

integrations/libraries/cline.mdx

Lines changed: 43 additions & 467 deletions
Large diffs are not rendered by default.

integrations/libraries/codex.mdx

Lines changed: 44 additions & 463 deletions
Large diffs are not rendered by default.

integrations/libraries/cursor.mdx

Lines changed: 38 additions & 414 deletions
Large diffs are not rendered by default.
Lines changed: 55 additions & 239 deletions
Original file line numberDiff line numberDiff line change
@@ -1,301 +1,117 @@
11
---
22
title: "GitHub Copilot"
3-
description: "Use Portkey with GitHub Copilot for centralized governance, observability, and cost controls."
3+
description: "Add observability, governance, and cost controls to GitHub Copilot with Portkey."
44
---
55

6-
GitHub Copilot is a popular AI pair programmer. By routing Copilot through Portkey, you gain enterprise-grade controls: unified model access, spend governance, observability, guardrails, and reliability features — without changing your editors or workflows.
6+
GitHub Copilot is an AI pair programmer. Route Copilot through Portkey to get:
7+
8+
- **1600+ LLMs** — Use any model, not just Copilot's defaults
9+
- **Observability** — Track costs, tokens, latency
10+
- **Governance** — Budget limits, rate limits, RBAC
11+
- **Guardrails** — PII detection, content filtering
712

813
<Note>
9-
This Experimental integration. You can only use Github Copilot Chat with Portkey. Advanced Copilot features are not available yet.
14+
**Experimental integration.** Only GitHub Copilot Chat works with Portkey. Advanced Copilot features are not available yet.
1015
</Note>
1116

12-
13-
# 1. Set up Portkey
14-
15-
Portkey lets you use 1600+ LLMs with GitHub Copilot via a simple OpenAI-compatible endpoint. We’ll create a model routing config and attach it to a Portkey API key.
17+
## 1. Setup Portkey
1618

1719
<Steps>
18-
<Step title="Create or verify your Integration">
19-
Go to <a href="https://app.portkey.ai/integrations">Integrations</a> and connect your provider (e.g., OpenAI, Anthropic, etc.).
20-
21-
1. Click **Connect** on your provider
22-
2. Enter a **Name** and **Slug**
23-
3. Provide provider credentials (API key and other required details)
24-
4. Finish model provisioning
20+
<Step title="Add Provider">
21+
Go to [Model Catalog](https://app.portkey.ai/model-catalog)**Add Provider**.
2522

2623
<Frame>
27-
<img src="/images/product/model-catalog/integrations-page.png" width="520" />
24+
<img src="/Screenshot2025-07-21at5.29.57PM.png" width="500"/>
2825
</Frame>
29-
30-
<Note>
31-
On the provisioning screen, you can keep default model selections or customize them.
32-
</Note>
3326
</Step>
3427

35-
<Step title="Copy the model slug">
36-
1. Open <a href="https://app.portkey.ai/model-catalog">Model Catalog</a> → **Models**
37-
2. Click your desired model (example: OpenAI’s GPT‑4o)
38-
3. Copy its **slug** (e.g., <code>@openai-dev/gpt-4o</code>)
28+
<Step title="Configure Credentials">
29+
Select your provider (OpenAI, Anthropic, etc.), enter your API key, and create a slug like `openai-prod`.
3930

4031
<Frame>
41-
<img src="/images/product/model-catalog/model-integration-model-box.png" width="520" />
32+
<img src="/images/product/model-catalog/create-provider-page.png" width="500"/>
4233
</Frame>
43-
44-
<Note>
45-
You can click **Run Test Request** here to validate your integration. If you see a permissions error, create a **User API Key** first under <a href="https://app.portkey.ai/api-keys">API Keys</a>.
46-
</Note>
4734
</Step>
4835

49-
<Step title="Create a Config in Portkey">
50-
Create a routing config that pins your Copilot traffic to the model from the previous step.
36+
<Step title="Copy Model Slug">
37+
Go to [Model Catalog](https://app.portkey.ai/model-catalog)**Models** → Copy the slug (e.g., `@openai-prod/gpt-4o`).
38+
39+
<Frame>
40+
<img src="/images/product/model-catalog/model-integration-model-box.png" width="500"/>
41+
</Frame>
42+
</Step>
5143

52-
1. Go to <a href="https://app.portkey.ai/configs">Configs</a>
53-
2. Create a new config with:
44+
<Step title="Create Config">
45+
Go to [Configs](https://app.portkey.ai/configs) and create:
5446

5547
```json
5648
{
57-
"override_params": {
58-
"model": "@YOUR_SLUG_FROM_PREVIOUS_STEP"
59-
}
49+
"override_params": {
50+
"model": "@openai-prod/gpt-4o"
51+
}
6052
}
6153
```
6254

63-
3. Give it a **Name** and **Save**
55+
Save and note the Config ID.
6456

6557
<Frame>
66-
<img src="/images/product/model-catalog/default-config-model-catalog.png" width="640" />
58+
<img src="/images/product/model-catalog/default-config-model-catalog.png" width="600"/>
6759
</Frame>
6860
</Step>
6961

70-
<Step title="Attach the Config to a Portkey API Key">
71-
Create an API key and attach your default config.
72-
73-
1. Go to <a href="https://app.portkey.ai/api-keys">API Keys</a>
74-
2. Click **Create**
75-
3. Choose the **Config** you created above
76-
4. Save your API key securely
62+
<Step title="Get Portkey API Key">
63+
Go to [API Keys](https://app.portkey.ai/api-keys) → Create new key → Attach your config → Save.
7764

7865
<Frame>
79-
<img src="/images/integrations/api-key.png" width="320" />
66+
<img src="/images/integrations/api-key.png" width="300"/>
8067
</Frame>
81-
82-
<Card title="Enforce Default Configs" href="/product/administration/enforce-default-config">
83-
Learn how to enforce the attached config and optionally disable overrides.
84-
</Card>
8568
</Step>
8669
</Steps>
8770

88-
<Check>
89-
🎉 Step 1 complete! You now have a Portkey API key with a default config that selects your model.
90-
</Check>
91-
92-
93-
# 2. Integrate Portkey with GitHub Copilot
94-
95-
Copilot lets you manage models by provider. We’ll configure it via the **Azure** provider option and point it to Portkey’s OpenAI-compatible endpoint.
71+
## 2. Configure GitHub Copilot
9672

9773
<Steps>
98-
<Step title="Open Manage Models in Copilot">
99-
1. In the Copilot chat view, click the **CURRENT-MODEL** dropdown
100-
2. Click **Manage Models…**
101-
74+
<Step title="Open Manage Models">
75+
In Copilot chat, click the **model dropdown****Manage Models**.
10276

10377
<Frame>
104-
<img src="/images/libraries/github-copilot-1.webp" width="520" />
78+
<img src="/images/libraries/github-copilot-1.webp" width="500"/>
10579
</Frame>
10680

107-
108-
109-
110-
You’ll see a list of providers.
111-
112-
11381
<Frame>
114-
<img src="/images/libraries/github-copilot-providers.png" width="520" />
82+
<img src="/images/libraries/github-copilot-providers.png" width="500"/>
11583
</Frame>
116-
11784
</Step>
11885

119-
<Step title="Select Azure and configure a new model">
120-
1. Choose **Azure**
121-
2. Click the **gear** icon next to Azure
122-
3. Click **Configure models****Add a new model**
123-
124-
Fill in the details:
125-
126-
- **Identifier**: a unique key for this model, e.g., <code>portkey-model</code>
127-
- **Display name**: e.g., <code>Custom Portkey Model</code>
128-
- **API endpoint URL**: <code>https://api.portkey.ai/v1/chat/completions</code>
129-
- **Capabilities**: enable <em>Tools</em>, <em>Vision</em>, and <em>Thinking</em> (as needed for your use)
130-
- **Maximum context tokens**: use your provider’s documented limit; keep defaults if unsure
131-
- **Maximum output tokens**: set per your usage; adjust later if needed
86+
<Step title="Add Custom Model via Azure">
87+
1. Select **Azure** → Click **gear icon****Configure models****Add a new model**
88+
2. Fill in:
89+
- **Identifier**: `portkey-model`
90+
- **Display name**: `Custom Portkey Model`
91+
- **API endpoint URL**: `https://api.portkey.ai/v1/chat/completions`
92+
- **Capabilities**: Enable Tools, Vision, Thinking as needed
93+
- **Token limits**: Set based on your model
13294

13395
<Frame>
134-
<img src="/images/libraries/github-copilot-2.png" width="520" />
96+
<img src="/images/libraries/github-copilot-2.png" width="500"/>
13597
</Frame>
136-
137-
138-
139-
140-
After saving, you should see your **Custom Portkey Model** in Copilot’s model list.
14198
</Step>
14299

143-
<Step title="Provide your Portkey API key">
144-
1. From **Manage Models…**, select **Azure**
145-
2. Pick the model you just created
146-
3. In the **API Keys** section, paste your **Portkey Workspace API Key** (the one with the default config from Step 1)
147-
4. Save
148-
100+
<Step title="Add API Key">
101+
1. From **Manage Models** → Select **Azure** → Select your model
102+
2. In **API Keys**, paste your **Portkey API Key**
103+
3. Save
149104

150105
<Frame>
151-
<img src="/images/libraries/github-copilot-2.png" width="520" />
106+
<img src="/images/libraries/github-copilot-models.png" width="500"/>
152107
</Frame>
153-
154-
155-
156-
157-
<Frame>
158-
<img src="/images/libraries/github-copilot-models.png" width="520" />
159-
</Frame>
160-
161-
162-
163-
164-
You can now use your Portkey-routed model in Copilot chat.
165108
</Step>
166109
</Steps>
167110

168-
<Check>
169-
✅ Copilot is now integrated with Portkey. Your requests will go through Portkey with the configured routing, guardrails, and analytics.
170-
</Check>
171-
111+
Done! Your Copilot requests now route through Portkey with observability and controls.
172112

113+
---
173114

115+
import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
174116

175-
# Portkey Features
176-
Now that you have enterprise-grade Github Copilot Chat setup, let's explore the comprehensive features Portkey provides to ensure secure, efficient, and cost-effective AI agent operations.
177-
178-
### 1. Comprehensive Metrics
179-
Using Portkey you can track 40+ key metrics including cost, token usage, response time, and performance across all your LLM providers in real time. You can also filter these metrics based on custom metadata that you can set in your configs. Learn more about metadata here.
180-
181-
<Frame>
182-
<img src="/images/integrations/observability.png" width="600"/>
183-
</Frame>
184-
185-
### 2. Advanced Logs
186-
Portkey's logging dashboard provides detailed logs for every request made by Github Copilot Chat. These logs include:
187-
- Complete request and response tracking for debugging
188-
- Metadata tags for filtering by team or project
189-
- Cost attribution per task
190-
- Complete conversation history with the AI agent
191-
192-
<Frame>
193-
<img src="/images/llms/openai/logs.png"></img>
194-
</Frame>
195-
196-
197-
198-
199-
### 3. Unified Access to 1600+ LLMs
200-
201-
You can easily switch between 1600+ LLMs. Call various LLMs such as Anthropic, Gemini, Mistral, Azure OpenAI, Google Vertex AI, AWS Bedrock, and many more by simply changing the `virtual key` in your default `config` object.
202-
203-
204-
### 4. Advanced Metadata Tracking
205-
Using Portkey, you can add custom metadata to your LLM requests for detailed tracking and analytics. Use metadata tags to filter logs, track usage, and attribute costs across engineering teams and projects.
206-
207-
<Card title="Custom Metadata" icon="coins" href="/product/observability/metadata">
208-
</Card>
209-
210-
211-
212-
### 5. Enterprise Access Management
213-
214-
<CardGroup cols={2}>
215-
<Card title="Budget Controls" icon="coins" href="/product/ai-gateway/virtual-keys/budget-limits">
216-
Set and manage spending limits across teams and departments. Control costs with granular budget limits and usage tracking.
217-
</Card>
218-
219-
<Card title="Single Sign-On (SSO)" icon="key" href="/product/enterprise-offering/org-management/sso">
220-
Enterprise-grade SSO integration with support for SAML 2.0, Okta, Azure AD, and custom providers for secure authentication.
221-
</Card>
222-
223-
<Card title="Organization Management" icon="building" href="/product/enterprise-offering/org-management">
224-
Hierarchical organization structure with workspaces, teams, and role-based access control for enterprise-scale deployments.
225-
</Card>
226-
227-
<Card title="Access Rules & Audit Logs" icon="shield-check" href="/product/enterprise-offering/access-control-management#audit-logs">
228-
Comprehensive access control rules and detailed audit logging for security compliance and usage tracking.
229-
</Card>
230-
</CardGroup>
231-
232-
233-
### 6. Reliability Features
234-
<CardGroup cols={3}>
235-
<Card title="Fallbacks" icon="life-ring" href="/product/ai-gateway/fallbacks">
236-
Automatically switch to backup targets if the primary target fails.
237-
</Card>
238-
<Card title="Conditional Routing" icon="route" href="/product/ai-gateway/conditional-routing">
239-
Route requests to different targets based on specified conditions.
240-
</Card>
241-
<Card title="Load Balancing" icon="key" href="/product/ai-gateway/load-balancing">
242-
Distribute requests across multiple targets based on defined weights.
243-
</Card>
244-
<Card title="Caching" icon="database" href="/product/ai-gateway/cache-simple-and-semantic">
245-
Enable caching of responses to improve performance and reduce costs.
246-
</Card>
247-
<Card title="Smart Retries" icon="database" href="/product/ai-gateway/automatic-retries">
248-
Automatic retry handling with exponential backoff for failed requests
249-
</Card>
250-
<Card title="Budget Limits" icon="shield-check" href="/product/ai-gateway/virtual-keys/budget-limits">
251-
Set and manage budget limits across teams and departments. Control costs with granular budget limits and usage tracking.
252-
</Card>
253-
</CardGroup>
254-
255-
256-
257-
### 7. Advanced Guardrails
258-
259-
Protect your codebase and enhance reliability with real-time checks on LLM inputs and outputs. Leverage guardrails to:
260-
- Prevent sensitive code or API key leaks
261-
- Enforce compliance with coding standards
262-
- PII detection and masking in generated code
263-
- Content filtering for inappropriate code generation
264-
- Custom security rules for your organization
265-
- Compliance checks for internal coding policies
266-
267-
<Card title="Guardrails" icon="shield-check" href="/product/guardrails">
268-
Implement real-time protection for your AI agent interactions with automatic detection and filtering of sensitive content, PII, and custom security rules. Enable comprehensive data protection while maintaining compliance with organizational policies.
269-
</Card>
270-
271-
272-
273-
# FAQs
274-
275-
<AccordionGroup>
276-
<Accordion title="What endpoint should I use in Copilot?">
277-
Use <code>https://api.portkey.ai/v1/chat/completions</code> for OpenAI-compatible chat completions.
278-
</Accordion>
279-
<Accordion title="Which capabilities should I enable?">
280-
Enable the ones your workflows need (Tools/Function Calling, Vision, Thinking). You can change them later.
281-
</Accordion>
282-
<Accordion title="How do I enforce a fixed model or routing policy?">
283-
Attach a default config to the API key and optionally disable overrides. See <a href="/product/administration/enforce-default-config">Enforcing Default Configs</a>.
284-
</Accordion>
285-
<Accordion title="How do I track costs per team?">
286-
Issue separate API keys or use metadata. Monitor in the analytics dashboard.
287-
</Accordion>
288-
</AccordionGroup>
289-
290-
291-
# Next Steps
292-
293-
**Join our Community**
294-
- [Discord Community](https://portkey.sh/discord-report)
295-
- [GitHub Repository](https://github.com/Portkey-AI)
296-
297-
<Note>
298-
For enterprise support or custom features, contact our <a href="https://calendly.com/portkey-ai">enterprise team</a>.
299-
</Note>
300-
301-
117+
<AdvancedFeatures />

0 commit comments

Comments
 (0)