> 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/openai.md).

# OpenAI

## Get API Key

* On the official [API Key page](https://platform.openai.com/api-keys) Click<mark style="background-color:green;">`+ Create new secret key`</mark>

<img src="https://1658303467-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0Ut5BptC3t8CtSU1UWpM%2Fuploads%2Fgit-blob-159901909dca352408b76ab8ab813843abe5140d%2Ffile.excalidraw%20(1).svg?alt=media" alt="" class="gitbook-drawing">

* Copy the generated key and open CherryStudio's [model service settings](/docs/en-us/pre-basic/providers/providers.md)
* Find the provider OpenAI and enter the key you just obtained

<figure><img src="https://1658303467-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0Ut5BptC3t8CtSU1UWpM%2Fuploads%2Fgit-blob-9857794ccb60aa975a538ead53925ab2c2561487%2Fimage%20(9)%20(2).png?alt=media" alt=""><figcaption></figcaption></figure>

* Click Manage or Add at the bottom, add supported models, and turn on the provider switch in the upper-right corner to use it.

{% hint style="info" %}

* OpenAI services cannot be used directly in China except in Taiwan; you must resolve proxy issues yourself;
* A balance is required.
  {% endhint %}

***

### Get help and submit feedback

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


---

# 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/openai.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.
