> For the complete documentation index, see [llms.txt](https://docs.cherryai.com.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cherryai.com.cn/docs/en-us/pre-basic/providers/newapi.md).

# NewAPI

Cherry Studio has built in support for the New API provider. A single New API address can connect to OpenAI Chat, OpenAI Responses, Anthropic Messages, and Gemini protocols at the same time, without needing to add a separate provider for each protocol.

## Configuration steps

1. Create and copy a token in the New API admin panel;
2. Open Cherry Studio \[Settings] → \[Model Services] → \[New API];
3. Fill in \[API Key];
4. In \[API Address], enter the root address of the New API, for example `https://api.example.com`;
5. Obtain or manually add the model, and after completing \[Test], turn on the enable switch in the upper right corner.

Cherry Studio will automatically use the corresponding version path according to the selected protocol, for example `/v1` or `/v1beta`. Usually you only need to enter the root address once; do not paste the full endpoint path such as `/chat/completions` into it.

{% hint style="warning" %}
If you have previously used the beta version and kept old values such as `localhost:3000` in other protocol addresses, go to the New API settings, clear the old address for the non-default protocol once, and then test again. Otherwise, some models may still request the old address.
{% endhint %}

<details>

<summary>What should I do if the proxy station uses a path without a version?</summary>

Only when the proxy station explicitly requires a path without `/v1` or `/v1beta` should you append `#`to the end of the corresponding API address.`#` This means version paths will no longer be appended automatically; do not use it for a normal New API deployment.

</details>

{% hint style="info" %}
The address must keep the correct `http://` or `https://`. When using an IP and port, you can enter a root address such as `http://127.0.0.1:3000` .
{% endhint %}

***

### Get help and submit feedback

If you encounter any questions, bugs, or feature improvement suggestions during configuration or use, please refer to the official channels provided in [Feedback and Suggestions](/docs/en-us/question-contact/suggestions.md) .


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cherryai.com.cn/docs/en-us/pre-basic/providers/newapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.