Get Glyph
Warning This documentation is still a work in progress. Some details may be out of date depending on the version of Glyph you are using, but it is being actively reviewed and improved.
Documentation AI Assistant Development Licensing

Documentation

OpenAI Configuration

Set up OpenAI GPT models in Glyph

Connect Glyph to OpenAI’s API to use the current GPT-5 family, GPT-4.1, and other OpenAI models.

Prerequisites

  • OpenAI API account: platform.openai.com
  • API key with appropriate permissions
  • Sufficient API credits

Setup

Get API Key

  1. Log in to OpenAI Platform
  2. Navigate to API Keys in your account settings
  3. Click Create new secret key
  4. Copy the key (starts with sk-)

Warning

Store your API key securely. OpenAI only shows it once.

Open Glyph AI Settings

Go to Settings → AI and select the OpenAI profile.

Add API Key

  1. Click Set API Key in the authentication section
  2. Paste your OpenAI API key
  3. Click Save

The key is stored locally in Glyph’s per-space internal data.

Select Model

Click the Model dropdown. Glyph fetches available models from OpenAI’s API.

Popular current models:

  • gpt-5 - Best default choice for most users
  • gpt-5-pro - More compute for harder reasoning and coding tasks
  • gpt-5-mini - Faster and lower cost
  • gpt-5-nano - Smallest high-throughput GPT-5 option
  • gpt-4.1 - Strong fallback for chat and tool use

Depending on your account and API access, you may also see dated variants or aliases such as gpt-5-chat-latest.

Test Connection

Open the AI panel and send a test message. You should receive a response from your selected model.

Configuration

Provider Settings

  • Service: openai
  • Base URL: https://api.openai.com/v1 (default)
  • Authentication: Bearer token (API key)

Custom Endpoint

To use a custom OpenAI endpoint (proxy, Azure OpenAI, etc.):

  1. Set Base URL to your endpoint
  2. Add any required headers in Custom Headers
  3. Enable Allow Private Hosts if using localhost
Base URL: https://<resource-name>.openai.azure.com/openai/deployments/<deployment-name>
Headers:
[
  { "key": "api-key", "value": "your-azure-api-key" },
  { "key": "api-version", "value": "2024-02-15-preview" }
]
Base URL: https://your-proxy.com/v1
Headers: (if required by proxy)

Model Selection

Glyph fetches the latest model list from OpenAI’s /v1/models endpoint.

ModelUse Case
gpt-5Best default choice for complex reasoning, coding, and agentic tasks
gpt-5-proHarder problems where quality matters more than latency
gpt-5-miniBalanced speed, price, and capability
gpt-5-nanoLightweight, high-throughput tasks
gpt-4.1Strong non-reasoning fallback for chat and tool use

Note

Glyph displays models returned by the API. If a model isn’t listed, type its ID manually in the model field.

Chat Completion Models Only

Glyph uses the /v1/chat/completions endpoint. Ensure your selected model supports chat completions.

Warning

Models like text-davinci-003 or gpt-3.5-turbo-instruct are not chat models. If you select one, you’ll see:

Model 'gpt-3.5-turbo-instruct' is not chat-completions compatible.
Select a chat-capable model (for example, a current GPT-5 or GPT-4.1 model).

Features

Chat Mode

Conversational interaction without tools:

  • Back-and-forth dialogue
  • Faster responses (no tool overhead)
  • Best for brainstorming and discussion

Create Mode

AI with workspace access:

  • File reading via read_file tool
  • Search notes with search_notes tool
  • List files with list_dir tool
  • Best for research and knowledge retrieval

Context Attachment

Attach files or folders to ground responses:

  • Attach via context menu in AI panel
  • Mention files with @filename syntax
  • Context sent in system message
  • Token estimates shown before sending

API Usage and Billing

Glyph makes direct API calls to OpenAI:

Cost Estimation

Use the context manifest in Glyph to estimate token usage, then compare it with the current pricing on OpenAI’s pricing page .

Rate Limits

OpenAI enforces rate limits based on your usage tier and the specific model you choose.

If you hit rate limits, Glyph displays the error from OpenAI. Wait before retrying or upgrade your tier.

Troubleshooting

”API key not set for this profile”

Solution: Add your OpenAI API key in Settings → AI.

”model list failed (401)”

Solution: Your API key is invalid or expired. Generate a new key from OpenAI Platform.

”model list failed (429)”

Solution: You’ve hit OpenAI’s rate limit. Wait before retrying.

”This model is not chat-completions compatible”

Solution: Select a current chat-capable model like gpt-5, gpt-5-mini, or gpt-4.1.

Model list is empty

Solution: Type the model ID manually (for example, gpt-5 or gpt-4.1). The model can still work even if the list fetch failed.

Responses are slow

Possible causes:

  • Large context (10K+ tokens)
  • Complex tool usage in create mode
  • OpenAI API latency

Solution: Try a faster model like gpt-5-mini or reduce context size.

Security Best Practices

Warning

  • Never commit .glyph/ secrets or app-managed data to version control
  • Rotate API keys if exposed
  • Use separate keys for different projects
  • Set spending limits in OpenAI dashboard

Next Steps