diff --git a/code-studio-ide-toc.html b/code-studio-ide-toc.html index d93a245..80def27 100644 --- a/code-studio-ide-toc.html +++ b/code-studio-ide-toc.html @@ -106,6 +106,9 @@
  • How to Add Free/Ollama Models
  • +
  • + How to Add Custom Endpoint Providers +
  • Development Setup diff --git a/code-studio/ide/how-to-guides/custom-endpoint-providers.md b/code-studio/ide/how-to-guides/custom-endpoint-providers.md new file mode 100644 index 0000000..da7310b --- /dev/null +++ b/code-studio/ide/how-to-guides/custom-endpoint-providers.md @@ -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**. + +custom-endpoint-setting + +### Step 2 +Click **Add Models** and select **Custom Endpoints** from the dropdown menu. + +custom-endpoint-selection + +### Step 3 +Enter your API key and select the endpoint supported by your model provider. + +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. + +custom-endpoint-api-selection + +### Step 4 +Add the required model configuration to the JSON file, including: +- Model name +- Endpoint details +- Provider-specific settings + +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. + +custom-endpoint-model diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api-selection.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api-selection.png new file mode 100644 index 0000000..6b01aab Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api-selection.png differ diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api.png new file mode 100644 index 0000000..9bf3548 Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-api.png differ diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-config.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-config.png new file mode 100644 index 0000000..d118e36 Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-config.png differ diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-model.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-model.png new file mode 100644 index 0000000..84e911a Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-model.png differ diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-selection.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-selection.png new file mode 100644 index 0000000..9a0a0da Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-selection.png differ diff --git a/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-setting.png b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-setting.png new file mode 100644 index 0000000..d41186f Binary files /dev/null and b/code-studio/ide/how-to-guides/howtoguide-images/custom-endpoint-setting.png differ