A flexible and secure Go SDK for OpenAI and OpenAI-compatible APIs including local models like Ollama.

• 🔌 Multi-Provider Support: OpenAI, Azure OpenAI, DeepSeek, ZhiPu, Ollama, and any OpenAI-compatible API
• 🛡️ Security First: Comprehensive validation, TLS warnings, safe error handling
• 🧪 Well-Tested: 71.2% test coverage with comprehensive unit tests
• 🚀 Developer-Friendly: Clean functional options pattern, extensive documentation
• ⚡ Performant: Optimized HTTP client, connection pooling, context-aware
• 🔧 Flexible: Support for custom BaseURL, proxies, timeouts, and all OpenAI parameters

go get github.com/ysicing/openai

package main

import (
    "context"
    "log"
    "os"

    "github.com/ysicing/openai/openai"
)

func main() {
    client, err := openai.New(
        openai.WithToken(os.Getenv("OPENAI_API_KEY")),
        openai.WithModel(openai.GPT4oMini),
    )
    if err != nil {
        log.Fatal(err)
    }

    resp, err := client.Completion(
        context.Background(),
        "You are a helpful assistant.",
        "Explain quantum computing in simple terms",
    )
    if err != nil {
        log.Fatal(err)
    }

    log.Println(resp.Content)
}

client, err := openai.New(
    openai.WithToken(os.Getenv("DEEPSEEK_API_KEY")),
    openai.WithBaseURL("https://api.deepseek.com/v1"),
    openai.WithModel(openai.DeepseekChat),
)

It is recommended to prioritize using WithBaseURL over WithProvider. WithProvider has limited support.

✅ = Built-in provider with special configuration

All other providers use the default OpenAI-compatible mode. Just specify the endpoint:

// DeepSeek
openai.WithBaseURL("https://api.deepseek.com/v1")

// ZhiPu (智谱)
openai.WithBaseURL("https://open.bigmodel.cn/api/paas/v4/")

// LM Studio, LocalAI, vLLM, etc.
openai.WithBaseURL("http://localhost:1234/v1")

Compatible with any OpenAI-compatible service:

• DeepSeek, ZhiPu, Moonshot, Kimi, Qwen, etc. (Chinese providers)
• LM Studio, LocalAI, vLLM (Self-hosted)
• Any other service with OpenAI-compatible API

We use a simplified approach:

• ✅ Only OpenAI, Azure, and Ollama have special configurations
• ✅ All other providers use default OpenAI-compatible mode
• ✅ Just use WithBaseURL to specify the endpoint

This design makes the code simpler and supports more services!

messages := []openai.ChatCompletionMessage{
    {Role: openai.ChatMessageRoleUser, Content: "Hello!"},
}

resp, err := client.CreateChatCompletionWithMessage(context.Background(), messages)
if err != nil {
    log.Fatal(err)
}

messages = append(messages, resp.Choices[0].Message)
messages = append(messages, openai.ChatCompletionMessage{
    Role: openai.ChatMessageRoleUser,
    Content: "What is your name?",
})

resp2, err := client.CreateChatCompletionWithMessage(context.Background(), messages)

resp, err := client.ImageCompletion(
    context.Background(),
    "https://example.com/image.jpg",
    "You are a helpful assistant.",
    "Describe this image in detail",
)

client, err := openai.New(
    openai.WithToken("api-key"),
    openai.WithHeaders([]string{
        "X-Custom-Header=custom-value",
        "Authorization=Bearer token",
    }),
)

• ✅ Response Validation: Prevents panics on malformed API responses
• ✅ TLS Warnings: Clear documentation about security implications of WithSkipVerify
• ✅ Safe Error Handling: No credential leakage in error messages
• ✅ Input Validation: Robust header parsing with SplitN
• ✅ Proxy Security: Support for both HTTP and SOCKS5 proxies

Run all tests:

go test ./... -v

With coverage report:

go test ./... -cover

Test results:

PASS
coverage: 71.2% of statements
ok      github.com/ysicing/openai/openai    0.496s

See the example/ directory for complete working examples:

• example/deepseek/ - DeepSeek API usage
• example/zhipu/ - ZhiPu API usage
• example/ollama/ - Local Ollama usage

# Run DeepSeek example
cd example/deepseek
DEEPSEEK_API_KEY=your_key go run main.go

# Run Ollama example (requires Ollama running)
cd example/ollama
ollama run llama3.1:latest
go run main.go

Contributions are welcome! Please feel free to submit a Pull Request.

MIT License - see LICENSE file for details.

• sashabaranov/go-openai - OpenAI Go library
• Ollama - Local AI models
• All contributors and users of this SDK