OpenAI Go API Library

The OpenAI Go library provides convenient access to the OpenAI REST API from applications written in Go.

[!WARNING] The latest version of this package has small and limited breaking changes. See the changelog for details.

Installation

import (
	"github.com/openai/openai-go/v3" // imported as openai
)

Or to pin an SDK version (see the Go compatibility note below):

go get -u 'github.com/openai/openai-go/[email protected]'

Requirements

This version requires Go 1.26 or later. Use the latest patch release of Go 1.26 or Go 1.27; the HTTP/2 security fixes require Go 1.26.9 or Go 1.27.2 or later patches in those release lines.

If your application must remain on Go 1.25, pin SDK v3.74.0, the final compatible release. For Go 1.22–1.24, pin SDK v3.44.0. These older SDK releases receive no guaranteed fixes or security backports, and v3.74.0 retains the affected HTTP/2 dependency. Upgrade your Go toolchain to use the security update.

See the Go version support policy for the supported release window and upgrade guidance.

Usage

The full API of this library can be found in api.md.

The primary API for interacting with OpenAI models is the Responses API. You can generate text from the model with the code below.

package main

import (
	"context"

	"github.com/openai/openai-go/v3"
	"github.com/openai/openai-go/v3/option"
	"github.com/openai/openai-go/v3/responses"
)

func main() {
	ctx := context.Background()
	client := openai.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("OPENAI_API_KEY")
	)

	question := "Write me a haiku about computers"

	resp, err := client.Responses.New(ctx, responses.ResponseNewParams{
		Input: responses.ResponseNewParamsInputUnion{OfString: openai.String(question)},
		Model: openai.ChatModelGPT5_2,
	})

	if err != nil {
		panic(err)
	}

	println(resp.OutputText())
}

response, err := client.Responses.New(ctx, responses.ResponseNewParams{
	Model: openai.ChatModelGPT5_2,
	Input: responses.ResponseNewParamsInputUnion{
		OfString: openai.String("What is the capital of France?"),
	},
})
if err != nil {
	panic(err)
}
fmt.Println("First response:", response.OutputText())

// Use PreviousResponseID to continue the conversation
response, err = client.Responses.New(ctx, responses.ResponseNewParams{
	Model:              openai.ChatModelGPT5_2,
	PreviousResponseID: openai.String(response.ID),
	Input: responses.ResponseNewParamsInputUnion{
		OfString: openai.String("And what is the population of that city?"),
	},
})
if err != nil {
	panic(err)
}
fmt.Println("Second response:", response.OutputText())

conv, err := client.Conversations.New(ctx, conversations.ConversationNewParams{})
if err != nil {
	panic(err)
}
fmt.Println("Created conversation:", conv.ID)

response, err := client.Responses.New(ctx, responses.ResponseNewParams{
	Model: openai.ChatModelGPT5_2,
	Input: responses.ResponseNewParamsInputUnion{
		OfString: openai.String("Hello! Remember that my favorite color is blue."),
	},
	Conversation: responses.ResponseNewParamsConversationUnion{
		OfConversationObject: &responses.ResponseConversationParam{
			ID: conv.ID,
		},
	},
})
if err != nil {
	panic(err)
}
fmt.Println("First response:", response.OutputText())

// Continue the conversation
response, err = client.Responses.New(ctx, responses.ResponseNewParams{
	Model: openai.ChatModelGPT5_2,
	Input: responses.ResponseNewParamsInputUnion{
		OfString: openai.String("What is my favorite color?"),
	},
	Conversation: responses.ResponseNewParamsConversationUnion{
		OfConversationObject: &responses.ResponseConversationParam{
			ID: conv.ID,
		},
	},
})
if err != nil {
	panic(err)
}
fmt.Println("Second response:", response.OutputText())

items, err := client.Conversations.Items.List(ctx, conv.ID, conversations.ItemListParams{})
if err != nil {
	panic(err)
}
fmt.Println("Conversation has", len(items.Data), "items")

ctx := context.Background()

stream := client.Responses.NewStreaming(ctx, responses.ResponseNewParams{
	Model: openai.ChatModelGPT5_2,
	Input: responses.ResponseNewParamsInputUnion{
		OfString: openai.String("Write a haiku about programming"),
	},
})
defer func() { _ = stream.Close() }()

for stream.Next() {
	event := stream.Current()
	print(event.Delta)
}

if stream.Err() != nil {
	panic(stream.Err())
}

See the full streaming example

This is the beginning of the README. Read the rest at the original. Read the full README ↗