Connect Yuque through an API Key auth config so that agents can access Yuque documents and knowledge bases.
The Yuque connector lets agents access documents and knowledge bases in Yuque. The data stays in Yuque and is read in real time when a tool is called.
Yuque is currently the only App that uses API Key authentication. You do not need to register an application on the Yuque side, only a token.
Yuque takes two stages: first create an auth config, then use it to create a connector.
After the connection succeeds, Connector generates tools for accessing Yuque content. Expand a tool in the Available tools section of the App details page to view its actual input and output parameters.
After a Yuque token becomes invalid, the connector status changes to Expired and tool calls start to fail.
How to handle it: generate a new token in Yuque, create a new auth config with the new value, rebuild the connector with the new config, and delete the old connector once you have confirmed that the new one works.
A single Yuque auth config can back multiple connectors. When you need to access different knowledge bases with different accounts, create one auth config per account and one connector for each, and tell them apart by connector name.
For how to manage them, see Connected accounts.
Prerequisites
- You already have a Yuque knowledge base, and you are using the public version of Yuque.
- A Yuque membership account. Creating a personal access token requires membership.
- That account has access permissions on the target knowledge base.
The permission level of the token determines what content Connector can read. When you only need read access, do not select write permissions.
Connection steps
Yuque takes two stages: first create an auth config, then use it to create a connector.
1
Obtain a Yuque token
Using a Yuque membership account, open the Token page in your personal settings, create a personal access token, and copy it for safekeeping. The token is shown in full only once, at creation time.For the detailed path, see API Key configuration.
Open the Yuque token page
Yuque personal settings → Token, where you create a personal access token
2
Create an auth config
In the left-side navigation of the console, click Auth configs, then click Create auth config.In the first step, select Yuque. Its authentication method is shown as API Key. Click Next.The second step prompts you to enter your Yuque API Key:
Click Finish to save.
| Field | Required | Description |
|---|---|---|
| Config name | No | Distinguishes multiple configs under the same App |
| API Key | Yes | The Yuque token you copied in the previous step |
3
Open the connection dialog
On the Apps page, find the Yuque card and click Connect.The dialog explains that authentication defines how users create connectors under the current App, and that authentication methods and credential selection are supported.
4
Select the config and confirm
In the Select auth config dropdown, select the config you just created, then click OK to complete the connection.The connector appears in the Connected users section of the App details page.