- Base URL
https://api.openai.com/v1- Default model
gpt-5.4- API key
- platform.openai.com/api-keys
Choose another model from the model menu if your OpenAI account does not have access to the default model.
Before you begin
SideCore does not include a shared AI account. You need an account and an API key from OpenAI, DeepSeek, or another OpenAI-compatible provider. An API key is different from the password used to sign in to a chat website.
Where to configure it: open SideCore → Settings → AI.
Choose a provider
Selecting OpenAI or DeepSeek fills in the matching service address and a default model. You normally only need to paste the API key.
- Base URL
https://api.deepseek.com- Default model
deepseek-v4-flash
If the default model is unavailable to your account, select another listed DeepSeek model.
- Base URL
- Provided by your service
- Model
- Enter the exact model ID
- API key
- Created in your provider dashboard
Use this option for an OpenAI-compatible gateway, proxy, self-hosted service, or another compatible provider.
Step-by-step setup
- Select the model provider Choose OpenAI, DeepSeek, or Custom. Changing the provider updates the suggested address and model.
- Check the Base URL For OpenAI and DeepSeek, keep the address filled by SideCore unless your provider explicitly gives you another endpoint.
- Choose or enter a model The model must exist and be enabled for your API account. Custom services require the exact model ID used by that service.
- Paste the API key Create a key in the provider dashboard and paste it into API Key. Do not paste your website login password.
- Click Test Connection A green success state means SideCore can reach the provider with the current address, model, and key. If it fails, SideCore displays the provider's error message.
What each field means
Field
Meaning
Model provider
Selects a preset configuration. It does not create an account or API key for you.
Base URL
The API server address. Use an API endpoint, not the provider's normal chat webpage.
Model
The model ID sent with each request. Access depends on the provider and your account.
API Key
A private credential created by the AI provider. Keep it secret and revoke it from the provider dashboard if exposed.
Connection test
Checks the complete configuration before you use an AI action in a note.
X
Configure X publishing
SideCore uses OAuth 2.0 to connect your X account and publish note text or images after your confirmation.
What to prepare
- An X developer account and an app created in the Developer Console.
- OAuth 2.0 enabled under User authentication settings.
- Client ID and Client Secret from the app's Keys and tokens page.
- Prepaid X API credits if you want to publish through the API.
Required configuration
- App permissions: Read and write.
- App type: Web App, Automated App or Bot.
- Scopes requested by SideCore: tweet.read, tweet.write, users.read, offline.access.
- Callback URL: copy the exact value displayed by SideCore.
- Create or open your X appGo to console.x.com, select the project and app, then open User authentication settings.
- Configure OAuth and the callbackEnable OAuth 2.0, choose read and write access, and paste the Callback URL shown in SideCore exactly.
- Enter Client ID and Client SecretCopy the OAuth 2.0 credentials into Settings → Integrations → X. These fields are hidden by default and can be revealed or copied.
- Test, then connect the accountTest Connection saves and validates the credentials. Connect Account then opens X authorization so you can approve SideCore.
- Publish from a noteUse the publish button in the note toolbar and select X. API posting consumes X credits; browser posting remains available as an alternative.
Cost note: connecting with OAuth is free, but posting through the X API consumes prepaid credits. Posts containing links may cost substantially more than plain text.
Feishu / Lark
Configure Feishu / Lark
After OAuth authorization, SideCore can import supported Feishu documents and publish notes to Feishu.
What to prepare
- A custom app created on the Feishu Open Platform.
- The app's App ID and App Secret.
- The redirect URL displayed in SideCore.
- An optional folder token if published documents should enter a specific folder.
Required permissions
- Create an appOpen the Feishu developer console, create a custom app, and enable the web application / user identity capability required for OAuth.
- Add permissionsAdd every permission listed above in Permission Management, then publish or activate the app configuration as required by your organization.
- Add the redirect URLUnder Security settings → Redirect URL, paste the exact http://127.0.0.1 address shown in SideCore. Do not replace it with sidecore://.
- Enter App ID and App SecretPaste both values into SideCore. The default folder token is optional; leave it empty to publish to the provider's default location.
- Choose read and write capabilitiesEnable document reading for imports and link title recognition; enable publishing if you want SideCore to create Feishu documents.
- Connect FeishuClick Connect Feishu, approve the requested permissions in the browser, and return after the local callback page reports completion.
Common omission: spreadsheet title recognition also requires
sheets:spreadsheet:read. Media import requires docs:document.media:download.
Dev.to
Configure Dev.to publishing
Dev.to is the simplest integration: create one API key, test it, and publish notes as articles.
- Create an API keySign in to Dev.to, open Settings → Extensions, and create an API key with a recognizable description such as SideCore.
- Paste the key in SideCoreEnable Dev.to under Settings → Integrations and paste the API key into the protected field.
- Test the connectionSideCore loads the current Dev.to user. The status must show Connected before publishing is enabled.
- Prepare the note and publishGive the note a title and non-empty body, then select Dev.to from the note publishing menu.
Cloudflare Pages
Configure Cloudflare Pages
SideCore can turn a note into a public standalone webpage and deploy it directly to a shared Pages project.
Minimum token permission
- Account → Cloudflare Pages → Edit.
- Account resources → select the account used for publishing.
For automatic Account ID detection
- Also add Account → Account Settings → Read.
- If you do not grant it, copy the Account ID from the Cloudflare dashboard and enter it manually.
- Create a custom API tokenOpen Cloudflare → My Profile → API Tokens → Create Custom Token. Do not use the Global API Key.
- Assign Pages permissionsAdd Cloudflare Pages Edit for the target account. Add Account Settings Read only if you want SideCore to find the Account ID automatically.
- Paste the token and testPaste the token into SideCore and click Test Connection. SideCore verifies the token and tries to resolve the account.
- Confirm Account IDIf the field remains empty or the test reports no accessible account, add the read permission or enter the Account ID manually.
- Choose a Pages projectThe default is sidecore-notes. You may enter another project name; SideCore creates the project during the first publish if needed.
- Publish a noteUse the note toolbar publishing menu and choose Cloudflare Pages. SideCore returns the public URL after deployment succeeds.
Configure AI actions
After the connection works, you can customize up to nine actions shown in SideCore's AI tools.
- Action name: the label displayed in SideCore. Leaving it empty uses the built-in fallback name.
- Prompt: the instruction sent with the selected note text.
- Replace by default: replaces the selected text with the AI result when enabled; otherwise the result is inserted without replacing it.
- Shortcut: configured separately in Settings → Shortcuts. The AI page displays the shortcut currently assigned to each action.
- Summary prompt: a built-in read-only instruction used by the note summary action.
Troubleshooting
401 / Unauthorized / Invalid API key
Create a new API key, paste it again without spaces, and confirm that the key belongs to the selected provider.
Model not found or access denied
Choose a model enabled for your API account. A model available in a chat app may not automatically be available through its API.
404 / Incorrect endpoint
Restore the preset Base URL, or check your custom provider's API documentation. Do not use a browser chat page as the Base URL.
Quota, balance, or rate-limit error
Check API billing, balance, quota, and rate limits in the provider dashboard. A paid chat subscription and paid API usage are often separate products.
Network or timeout error
Confirm the provider is reachable from your current network. If you use a proxy or private gateway, verify its address and certificate.
The browser authorization completed, but SideCore is still not connected
Check that the callback URL is copied exactly, the app permissions were published, and SideCore remained open during authorization. Then disconnect and connect again.
Credentials are filled in, but publishing is unavailable
Enable the integration and run Test Connection first. X and Feishu also require completing the browser account authorization step.
Privacy, storage, and billing
- Your AI configuration and API key are stored locally on your Mac.
- When you trigger an AI action, the selected text and prompt are sent directly to the provider you configured.
- SideCore does not proxy AI requests through a Ruska Apps server.
- AI API charges, data retention, and privacy rules are controlled by your provider and are separate from SideCore Pro.