Skip to content

Add Perplexity as a BYOK provider#5094

Open
jliounis wants to merge 1 commit intomicrosoft:mainfrom
jliounis:add-perplexity-byok-provider
Open

Add Perplexity as a BYOK provider#5094
jliounis wants to merge 1 commit intomicrosoft:mainfrom
jliounis:add-perplexity-byok-provider

Conversation

@jliounis
Copy link
Copy Markdown

Summary

Adds Perplexity as a Bring-Your-Own-Key (BYOK) language model provider in Copilot Chat. Perplexity exposes an OpenAI-compatible Chat Completions API at https://api.perplexity.ai, so the new provider extends AbstractOpenAICompatibleLMProvider — mirroring the existing xAI and OpenRouter providers.

After merging, users with a Perplexity API key can pick Perplexity from the BYOK provider dropdown and use Sonar models from Copilot Chat.

Changes

  • src/extension/byok/vscode-node/perplexityProvider.ts — new PerplexityLMProvider extending AbstractOpenAICompatibleLMProvider. Ships a curated list of currently-available models:
    • sonar-pro (default)
    • sonar
    • sonar-reasoning-pro
    • sonar-reasoning
  • src/extension/byok/vscode-node/byokContribution.ts — registers the new provider alongside Anthropic / xAI / OpenRouter / OpenAI / Gemini / Ollama / Azure / customoai.
  • package.json — adds the "perplexity" vendor entry under languageModelChatProviders with the standard apiKey configuration field.

Attribution header

The provider sends X-Pplx-Integration: vscode-copilot/<package-version> on every outgoing request (via BYOKModelCapabilities.requestHeaders, picked up by OpenAIEndpoint.getExtraHeaders) so Perplexity can attribute traffic to this integration. Set centrally in perplexityProvider.ts — not sprinkled across call sites.

Branding & defaults

  • Default model: sonar-pro
  • Branding: Perplexity in user-facing UI/docs (never "Sonar API")
  • Base URL: https://api.perplexity.ai
  • Auth: standard Authorization: Bearer <key> (BYOK key field)

Links

CLA

I'll sign the Microsoft CLA before merge — no blockers expected.

Test plan

  • Build the extension
  • Configure a Perplexity API key under the new "Perplexity" provider in BYOK settings
  • Verify sonar-pro, sonar, sonar-reasoning-pro, and sonar-reasoning show up in the model picker
  • Send a chat message and confirm streaming completion works
  • Confirm requests include X-Pplx-Integration: vscode-copilot/<version> header

Wires up Perplexity as a Bring-Your-Own-Key (BYOK) language model provider
in Copilot Chat. Perplexity exposes an OpenAI-compatible chat completions
API at https://api.perplexity.ai, so the new provider extends
AbstractOpenAICompatibleLMProvider, similar to the existing xAI and
OpenRouter providers.

- Adds src/extension/byok/vscode-node/perplexityProvider.ts with a curated
  list of Sonar models (sonar-pro, sonar, sonar-reasoning-pro,
  sonar-reasoning). sonar-pro is the default.
- Registers the provider in byokContribution.ts.
- Adds the "perplexity" vendor entry to languageModelChatProviders in
  package.json so the provider appears in the BYOK dropdown with an API
  key field.
- Sends an X-Pplx-Integration: vscode-copilot/<package-version> header on
  outgoing requests via BYOKModelCapabilities.requestHeaders so Perplexity
  can attribute traffic to this integration.

Docs: https://docs.perplexity.ai
Copilot AI review requested due to automatic review settings April 30, 2026 22:30
@microsoft-github-policy-service
Copy link
Copy Markdown

@jliounis please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Perplexity as a new BYOK (Bring-Your-Own-Key) language model provider, integrating it into Copilot Chat’s existing OpenAI-compatible BYOK provider framework and surfacing it in VS Code’s BYOK provider configuration UI.

Changes:

  • Introduces PerplexityLMProvider (OpenAI-compatible) with a curated set of Sonar models and an X-Pplx-Integration attribution header.
  • Registers Perplexity in the BYOK contribution so it becomes an available provider at runtime.
  • Adds a new perplexity vendor entry in package.json to expose API key configuration in the BYOK provider dropdown/settings.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
src/extension/byok/vscode-node/perplexityProvider.ts Adds the new Perplexity BYOK provider, model metadata, and integration header wiring.
src/extension/byok/vscode-node/byokContribution.ts Registers Perplexity provider alongside other BYOK providers.
package.json Adds Perplexity as a configurable languageModelChatProviders vendor with an apiKey field.

}

protected getModelsBaseUrl(): string | undefined {
return 'https://api.perplexity.ai';
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

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

getModelsBaseUrl() returns a base URL, which causes AbstractOpenAICompatibleLMProvider to always call ${baseUrl}/models for discovery. That contradicts the comment/PR description that Perplexity doesn't have a stable /models endpoint, and it also means the curated PERPLEXITY_KNOWN_MODELS list will never be shown unless the discovery call succeeds and returns those IDs. Consider overriding getAllModels (like CustomOAI does) to return the curated/merged known-model list with url set to the Perplexity base URL, optionally attempting discovery as a best-effort fallback rather than a hard dependency.

Suggested change
return 'https://api.perplexity.ai';
// Perplexity does not provide a stable /models discovery endpoint for this provider.
// Rely on the curated known-model list instead of enabling generic discovery.
return undefined;

Copilot uses AI. Check for mistakes.
Comment on lines +85 to +89
merged[id] = { ...caps, requestHeaders: { ...integrationHeader, ...(caps.requestHeaders ?? {}) } };
}
if (remote) {
for (const [id, caps] of Object.entries(remote)) {
merged[id] = { ...caps, requestHeaders: { ...integrationHeader, ...(caps.requestHeaders ?? {}) } };
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

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

The merge order for requestHeaders allows an existing caps.requestHeaders entry to override X-Pplx-Integration, which can accidentally drop or change the attribution header. If the intent is to guarantee the header on every request, apply the integration header last (so it wins) when merging curated and remote model capabilities.

Suggested change
merged[id] = { ...caps, requestHeaders: { ...integrationHeader, ...(caps.requestHeaders ?? {}) } };
}
if (remote) {
for (const [id, caps] of Object.entries(remote)) {
merged[id] = { ...caps, requestHeaders: { ...integrationHeader, ...(caps.requestHeaders ?? {}) } };
merged[id] = { ...caps, requestHeaders: { ...(caps.requestHeaders ?? {}), ...integrationHeader } };
}
if (remote) {
for (const [id, caps] of Object.entries(remote)) {
merged[id] = { ...caps, requestHeaders: { ...(caps.requestHeaders ?? {}), ...integrationHeader } };

Copilot uses AI. Check for mistakes.
Comment on lines +53 to +57
export class PerplexityLMProvider extends AbstractOpenAICompatibleLMProvider {

public static readonly providerName = 'Perplexity';

constructor(
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

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

A new BYOK provider is introduced but there are no accompanying unit tests under src/extension/byok/vscode-node/test/ (other providers like Ollama/Gemini/Azure have coverage). Adding a Perplexity provider spec would help lock in: the curated model list shown in the picker and that X-Pplx-Integration is present in each model's requestHeaders.

Copilot uses AI. Check for mistakes.
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