Getting API Keys for Solf AI Help

Start here

Enter the key in AI Help Settings

1. Open a Solf document.
2. Select AI Help in the right inspector.
3. Select the gear button.
4. Choose the provider that issued the credential.
5. Paste the key into the API Key field.
6. Complete any provider-specific settings and select Save.

Protect the key

• Do not share it with teachers, students, classmates, or support personnel.
• Set provider spending limits when available.
• Revoke and replace it if it may have been exposed.
• Use an institution-approved account when required.

When AI Help is used, selected context and questions are sent to the chosen provider. Review that provider’s terms and privacy practices before sending sensitive information.

OpenRouter

Create an OpenRouter key

1. Sign in at the OpenRouter API Keys page.
2. Add credits if required for the model you plan to use.
3. Create a key and give it a name such as “Solf AI Help.”
4. Copy the key and store it securely.

Configure Solf

Choose OpenRouter, paste the OpenRouter key, and enter the exact model identifier from the OpenRouter model catalog. Model identifiers generally use the form provider/model.

See the OpenRouter Quickstart.

OpenAI

Create an OpenAI API key

1. Sign in to the OpenAI API Keys page.
2. Select the appropriate project.
3. Create a new secret key and copy it when shown.
4. Configure API billing if required.

Configure Solf

Choose ChatGPT (OpenAI), paste the OpenAI API key, and select Save.

See the OpenAI developer quickstart.

Anthropic Claude

Create an Anthropic API key

1. Sign in to the Anthropic Console API Keys page.
2. Select the appropriate organization or workspace.
3. Create, name, and copy the key.
4. Configure Console billing if required.

Configure Solf

Choose Claude (Anthropic), paste the Anthropic API key, and select Save.

See Anthropic API access.

Microsoft Copilot Studio

Obtain a Direct Line credential

Solf requires a published Copilot Studio agent with Direct Line access. Consumer Microsoft Copilot does not provide this credential.

1. Open and publish the agent in Copilot Studio.
2. Open Settings → Security → Web channel security.
3. Configure secured access and copy a Direct Line secret or supported token.

Configure Solf

Choose Microsoft Copilot, enter the Direct Line credential, and confirm the endpoint:

https://directline.botframework.com/v3/directline

See Microsoft’s web and Direct Line security guide.

LM Studio

Connect a local model

LM Studio does not require a cloud-provider key by default.

1. Install LM Studio and load a chat model.
2. Open the Developer page and start the local server.
3. In Solf, choose LM Studio.
4. Enter the endpoint http://localhost:1234/v1/chat/completions.
5. Enter the exact loaded model identifier.

If LM Studio authentication is enabled, create a token in Developer → Server Settings → Manage Tokens and enter it in Solf’s optional API-token field.

See the LM Studio authentication guide.

Troubleshooting

Common connection problems

Missing or invalid key

Confirm that the correct provider is selected, the complete key was copied, and the key has not been revoked.

Insufficient credits

Review the provider’s API billing page. Consumer chat subscriptions generally do not include API usage.

OpenRouter model error

Copy the exact model identifier from OpenRouter rather than entering only the display name.

LM Studio cannot connect

Confirm that LM Studio is running, its local server is started, a model is loaded, and the endpoint and model identifier match.

Copilot cannot connect

Confirm that the agent is published, Direct Line is configured, the credential remains valid, and the endpoint is correct.