Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions code-studio-ide-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@
<li>
<a href="/code-studio/ide/how-to-guides/add-ollama-model">How to Add Free/Ollama Models </a>
</li>
<li>
<a href="/code-studio/ide/how-to-guides/custom-endpoint-providers">How to Add Custom Endpoint Providers</a>
</li>
</ul>
</li>
<li> Development Setup
Expand Down
71 changes: 71 additions & 0 deletions code-studio/ide/how-to-guides/custom-endpoint-providers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Custom Endpoint Providers
Description: Guide to configuring and using Custom Endpoint models in Syncfusion Code with your own API key and provider-specific endpoint configuration.
platform: syncfusion-code-studio
keywords: custom endpoint, custom model, api key, chat completions, responses api, messages api, model provider
tocname: code-studio-ide-toc
---

# Custom Endpoint Providers

## Overview
This guide provides step-by-step instructions to configure and use a Custom Endpoint model inside Syncfusion Code with your own API key. The Custom Endpoint provider supports endpoints compatible with the Chat Completions, Responses, and Messages APIs, allowing you to connect models from different providers through a single configuration.

## When to Use

- When you want to connect a model from an external provider using your own API key.
- When your provider supports the Chat Completions, Responses, or Messages endpoint.
- When you need more control over the model, endpoint type, and provider configuration.

## Prerequisites

- Valid API key from your model provider (used to authenticate and access the model endpoint)

## Configure Custom Endpoint

### Step 1
Open Syncfusion Code and click **Manage Language Model**.

<img src="./howtoguide-images/custom-endpoint-setting.png" alt="custom-endpoint-setting">

### Step 2
Click **Add Models** and select **Custom Endpoints** from the dropdown menu.

<img src="./howtoguide-images/custom-endpoint-selection.png" alt="custom-endpoint-selection">

### Step 3
Enter your API key and select the endpoint supported by your model provider.

<img src="./howtoguide-images/custom-endpoint-api.png" alt="custom-endpoint-api">

## Supported API Types
When configuring a Custom Endpoint, select the API type that matches the endpoint supported by your model provider.

### Chat Completions API

Use this option for providers that support the OpenAI-compatible Chat Completions format. This API is commonly used for conversational AI interactions where messages are exchanged between the user and the model.

### Responses API

Use this option for providers that support the Responses API. This API provides a unified interface for generating model outputs and supports advanced response handling capabilities.

### Messages API

Use this option for providers that use a Messages-based request format, such as Anthropic Claude models. The Messages API structures conversations as a sequence of messages exchanged between the user and the model.

> **Note:** Ensure that the selected API type matches the endpoint supported by your model provider. Choosing an incompatible API type may result in authentication or request errors.

<img src="./howtoguide-images/custom-endpoint-api-selection.png" alt="custom-endpoint-api-selection">

### Step 4
Add the required model configuration to the JSON file, including:
- Model name
- Endpoint details
- Provider-specific settings

<img src="./howtoguide-images/custom-endpoint-config.png" alt="custom-endpoint-config">

### Step 5
Open the Chat panel, select the configured **Custom Endpoint** model from the model picker, and start using it in your chat.

<img src="./howtoguide-images/custom-endpoint-model.png" alt="custom-endpoint-model">
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.