yetanotherrepo_obsidian-cop.../docs/how-to/OpenAI API setup guide.md
2026-05-30 12:34:34 +01:00

1.6 KiB

Setting Up the OpenAI API

Preparing Your OpenAI Account

  1. Navigate to the OpenAI API website.
  2. Sign in to your existing OpenAI account or create a new one if necessary.
  3. Ensure that your payment details are entered and current.

Obtaining OpenAI API Keys

  1. Navigate to the OpenAI API website.
  2. Select the API Keys tab from the left-hand menu.
  3. Click the + Create new secret key button.
  4. Store the generated API key securely.

Configuring the Plugin

  1. Open the Obsidian vault where this plugin is installed.
  2. Access the settings for this plugin.
  3. Paste the API key you copied earlier into the OpenAI API Key field in Quick Setup.
  4. Select one of the recommended models. GPT-5.4 mini is the default recommendation for autocomplete latency and quality.
  5. Test the connection by clicking the Test Connection button to ensure the API key is correct and the plugin can connect to the OpenAI API.
  6. Exit the settings window.
  7. The plugin is now ready for use. Begin typing, and upon reaching a trigger, such as the end of a sentence, the plugin will offer suggestions. Or manually trigger the plugin by opening the command palette and typing Copilot Auto Completion Plus: Predict.

Advanced Settings lets you change the OpenAI API URL, refresh the full model list, or point the plugin at an OpenAI-compatible local server.

Note: GPT-5 reasoning models do not support every classic sampling parameter. When using these models, the plugin omits unsupported OpenAI Responses API parameters such as temperature and top_p.