Claude Platform Docs
CLI、SDK、ライブラリクライアントSDK

Go SDK

コンテキストベースのキャンセルと関数型オプションを備えたAnthropic Go SDKのインストールと設定

Anthropic Goライブラリは、Goで書かれたアプリケーションからClaude APIへの便利なアクセスを提供します。

インストール

import (
	"github.com/anthropics/anthropic-sdk-go" // imported as anthropic
)

go getでインストールします:

go get github.com/anthropics/anthropic-sdk-go

要件

このライブラリにはGo 1.24以降が必要です。

使用方法

package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"), // defaults to os.LookupEnv("ANTHROPIC_API_KEY")
	)
	message, err := client.Messages.New(context.TODO(), anthropic.MessageNewParams{
		MaxTokens: 1024,
		Messages: []anthropic.MessageParam{
			anthropic.NewUserMessage(anthropic.NewTextBlock("What is a quaternion?")),
		},
		Model: anthropic.ModelClaudeOpus5,
	})
	if err != nil {
		panic(err.Error())
	}
	for _, block := range message.Content {
		if textBlock, ok := block.AsAny().(anthropic.TextBlock); ok {
			fmt.Println(textBlock.Text)
		}
	}
}

Workload Identity Federationを含む認証オプションについては、認証を参照してください。お使いのAPIキーが複数のワークスペースにアクセスできる個人キーまたはサービスアカウントキーである場合は、anthropic-workspace-idリクエストヘッダーにワークスペースIDを設定してください。ワークスペースを選択するでは、このSDKにおけるリクエストごとのオプションを示しています。

リクエストフィールド

anthropicライブラリは、リクエストフィールドに対してGo 1.24以降のencoding/jsonリリースのomitzeroセマンティクスを使用します。

必須のプリミティブフィールド(int64stringなど)には`json:"...,required"`タグが付いています。これらのフィールドは、ゼロ値であっても常にシリアライズされます。

オプションのプリミティブ型はparam.Opt[T]でラップされます。これらのフィールドは、anthropic.String(string)anthropic.Int(int64)などの提供されているコンストラクタで設定できます。

すべてのparam.Opt[T]、map、slice、struct、または文字列enumは`json:"...,omitzero"`タグを使用します。そのゼロ値は省略されたものとみなされます。

param.IsOmitted(any)関数を使用すると、任意のomitzeroフィールドの存在を確認できます。

p := anthropic.ExampleParams{
	ID:   "id_xxx",                // required property
	Name: anthropic.String("..."), // optional property

	Point: anthropic.Point{
		X: 0,                // required field will serialize as 0
		Y: anthropic.Int(1), // optional field will serialize as 1
		// ... 省略された必須でないフィールドはシリアライズされません
	},

	Origin: anthropic.Origin{}, // the zero value of [Origin] is considered omitted
}

param.Opt[T]の代わりにnullを送信するには、param.Null[T]()を使用します。 struct Tの代わりにnullを送信するには、param.NullStruct[T]()を使用します。

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

リクエストstructには.SetExtraFields(map[string]any)メソッドがあり、リクエストボディに非準拠のフィールドを送信できます。追加フィールドは、キーが一致するstructフィールドを上書きします。

structの代わりにカスタム値を送信するには、ジェネリック関数param.Overrideを使用します(例:param.Override[anthropic.FooParams](12))。

// APIが特定の型を指定しているものの、
// 別のものを送信したい場合は、[SetExtraFields]を使用します:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// オブジェクトの代わりに数値を送信する
custom := param.Override[anthropic.FooParams](12)

リクエストユニオン

ユニオンは、各バリアントに対して「Of」で始まるフィールドを持つstructとして表現され、非ゼロにできるフィールドは1つだけです。非ゼロのフィールドがシリアライズされます。

ユニオンのサブプロパティには、ユニオンstructのメソッドを通じてアクセスできます。 これらのメソッドは、基になるデータが存在する場合、そのデータへの変更可能なポインタを返します。

// ゼロ以外にできるフィールドは1つだけです。フィールドが設定されているか確認するには param.IsOmitted() を使用します
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline"`
	OfDog *Dog `json:",omitzero,inline"`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", ZipCode: 0},
		},
	},
}

// フィールドを変更する
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}

パラメータのデシリアライズ

Param型(MessageNewParamsToolUnionParamなど、Paramで終わる型)は、送信リクエスト専用に設計されています。JSONへのマーシャリングは正しく行われますが、ラウンドトリップのデシリアライズは完全にはサポートされていません。生のJSONをparam structにアンマーシャルすると、基になるJSONが有効であっても、OfBashTool20250124のような型付きユニオンフィールドはnilになります。

生のJSON(例えば、データベース、ミドルウェア、または以前のリクエストから)からparamsを再構築する必要がある場合は、UnmarshalJSONを呼び出して非ユニオンフィールドを設定し、次にparam.SetJSONを使用して正しく再シリアライズするための生のバイトを添付します:

// paramsをシリアライズします(例:保存や転送のため)
b, err := json.Marshal(original)
if err != nil {
	panic(err)
}

// 後で、保存したJSONからparamsを再構築します
var params anthropic.MessageNewParams
if err := params.UnmarshalJSON(b); err != nil {
	panic(err)
}
param.SetJSON(b, &params)

// params.Modelおよびその他のスカラーフィールドはUnmarshalJSONによって設定されます。
// params.Tools[0].OfBashTool20250124はnilです(unionの制限)が、
// 生のJSONは保持されます。API呼び出しのためにparamsが再度マーシャルされると、
// ツールは正しくシリアライズされます。
b2, _ := json.Marshal(params)
fmt.Println(string(b) == string(b2)) // true

このユースケースでは、より汎用的なparam.Override[T](any)よりもparam.SetJSON(v1.20.0以降で利用可能)が推奨されます。型パラメータを明示的に記述する必要がなく、ラウンドトリップの意図が明確になるためです。

レスポンスオブジェクト

レスポンスstructのすべてのフィールドは通常の値型です(ポインタやラッパーではありません)。 レスポンスstructには、各プロパティに関するメタデータを含む特別なJSONフィールドも含まれています。

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owners      respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

オプションのデータを扱うには、JSONフィールドの.Valid()メソッドを使用します。 .Valid()は、フィールドが存在し、nullでなく、正常にアンマーシャルされた場合にtrueを返します。

.Valid()がfalseの場合、対応するフィールドはゼロ値になります。

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// 通常のフィールドへのアクセス

res.Owners // 1
res.Name   // ""
res.Age    // 0

// オプションフィールドのチェック

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// 生のJSON値

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

これらの.JSON structには、structで指定されていないjsonレスポンス内のプロパティを含むExtraFieldsマップも含まれています。これは、SDKにまだ存在しないAPI機能に役立ちます。

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()

レスポンスユニオン

レスポンスでは、ユニオンは各オブジェクトバリアントのすべての可能なフィールドを含むフラット化されたstructとして表現されます。 バリアントに変換するには、.AsFooVariant()メソッド、または存在する場合は.AsAny()メソッドを使用します。

レスポンス値のユニオンにプリミティブ値が含まれる場合、プリミティブフィールドはプロパティと並んで配置されますが、Ofで始まり、json:"...,inline"タグが付きます。

type AnimalUnion struct {
	// バリアント [Dog]、[Cat] から
	Owner Person `json:"owner"`
	// バリアント [Dog] から
	DogBreed string `json:"dog_breed"`
	// バリアント [Cat] から
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// animal バリアントの場合
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// バリアントで分岐
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}

エラー処理

APIが成功以外のステータスコードを返すと、SDKは*anthropic.Error型のエラーを返します。これには、リクエストのStatusCode*http.Request*http.Responseの値と、エラーボディのJSON(SDKの他のレスポンスオブジェクトとほぼ同様)が含まれます。エラーにはレスポンスヘッダーからのRequestIDも含まれており、Anthropicサポートとのトラブルシューティングに役立ちます。

エラーを処理するには、errors.Asパターンを使用します:

_, err := client.Messages.New(context.TODO(), anthropic.MessageNewParams{
	MaxTokens: 1024,
	Messages: []anthropic.MessageParam{{
		Content: []anthropic.ContentBlockParamUnion{{
			OfText: &anthropic.TextBlockParam{
				Text: "What is a quaternion?",
			},
		}},
		Role: anthropic.MessageParamRoleUser,
	}},
	Model: anthropic.ModelClaudeOpus5,
})
if err != nil {
	var apierr *anthropic.Error
	if errors.As(err, &apierr) {
		println("Request ID:", apierr.RequestID)
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // POST "/v1/messages": 400 Bad Request (Request-ID: req_xxx) { ... }
}

その他のエラーが発生した場合は、ラップされずに返されます。例えば、HTTPトランスポートが失敗した場合、*net.OpErrorをラップした*url.Errorを受け取ることがあります。

リトライ

特定のエラーは、デフォルトで短い指数バックオフを伴って2回自動的にリトライされます。 SDKはデフォルトで、すべての接続エラー、408 Request Timeout、409 Conflict、429 Rate Limit、および500以上のInternalエラーをリトライします。

WithMaxRetriesオプションを使用して、これを設定または無効化できます:

// すべてのリクエストのデフォルトを設定:
client := anthropic.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// リクエストごとに上書き:

	client.Messages.New(
		context.TODO(),
		anthropic.MessageNewParams{
			MaxTokens: 1024,
			Messages: []anthropic.MessageParam{{
				Content: []anthropic.ContentBlockParamUnion{{
					OfText: &anthropic.TextBlockParam{
						Text: "What is a quaternion?",
					},
				}},
				Role: anthropic.MessageParamRoleUser,
			}},
			Model: anthropic.ModelClaudeOpus5,
		},
		option.WithMaxRetries(5),
	)

タイムアウト

非ストリーミングのMessagesリクエストはデフォルトで10分後にタイムアウトします。その他のリクエストにはデフォルトのタイムアウトはありません。リクエストのライフサイクルにタイムアウトを設定するには、contextを使用します。

リクエストがリトライされた場合、contextのタイムアウトは最初からやり直されないことに注意してください。 リトライごとのタイムアウトを設定するには、option.WithRequestTimeout()を使用します。

// リクエストのタイムアウトを設定します(すべてのリトライを含む)。
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()

	client.Messages.New(
		ctx,
		anthropic.MessageNewParams{
			MaxTokens: 1024,
			Messages: []anthropic.MessageParam{{
				Content: []anthropic.ContentBlockParamUnion{{
					OfText: &anthropic.TextBlockParam{
						Text: "What is a quaternion?",
					},
				}},
				Role: anthropic.MessageParamRoleUser,
			}},
			Model: anthropic.ModelClaudeOpus5,
		},
		// リトライごとのタイムアウトを設定します
		option.WithRequestTimeout(20*time.Second),
	)

長時間のリクエスト

ストリーミングを使用せずに大きなMaxTokens値を設定することは避けてください。一部のネットワークでは一定時間後にアイドル接続が切断される場合があり、Anthropicからレスポンスを受信することなくリクエストが失敗したりタイムアウトしたりする原因となる可能性があります。

このSDKは、非ストリーミングリクエストがおよそ10分を超えると予想される場合にもエラーを返します。 .Messages.NewStreaming()を呼び出すか、カスタムタイムアウトを設定すると、このエラーは無効になります。

ファイルアップロード

マルチパートリクエストでのファイルアップロードに対応するリクエストパラメータは、io.Readerとして型付けされています。io.Readerの内容は、デフォルトでファイル名「anonymous_file」、content-type「application/octet-stream」のマルチパートフォームパートとして送信されます。そのため、推奨されるアプローチは、任意のio.Readerを適切なファイル名とコンテンツタイプでラップするanthropic.File(reader io.Reader, filename string, contentType string)ヘルパーを使用してカスタムcontent-typeを指定することです。

// ファイルシステムからのファイル
file, err := os.Open("/path/to/file.json")
anthropic.FileUploadParams{
	File: anthropic.File(file, "custom-name.json", "application/json"),
}

// 文字列からのファイル
anthropic.FileUploadParams{
	File: anthropic.File(strings.NewReader("my file contents"), "custom-name.json", "application/json"),
}

ファイル名とcontent-typeは、io.Readerの実行時の型にName() stringまたはContentType() stringを実装することでもカスタマイズできます。os.FileName() stringを実装しているため、os.Openによって返されたファイルはディスク上のファイル名で送信されることに注意してください。

ページネーション

このライブラリは、ページネーションされたリストエンドポイントを扱うためのいくつかの便利な機能を提供します。

.ListAutoPaging()メソッドを使用して、すべてのページにわたってアイテムを反復処理できます:

iter := client.Messages.Batches.ListAutoPaging(context.TODO(), anthropic.MessageBatchListParams{
	Limit: anthropic.Int(20),
})
// 必要に応じて追加のページを自動的に取得します。
for iter.Next() {
	messageBatch := iter.Current()
	fmt.Println(messageBatch.ID)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

または、シンプルな.List()メソッドを使用して単一のページを取得し、.GetNextPage()のような追加のヘルパーメソッドを持つ標準のレスポンスオブジェクトを受け取ることもできます:

page, err := client.Messages.Batches.List(context.TODO(), anthropic.MessageBatchListParams{
	Limit: anthropic.Int(20),
})
for page != nil {
	for _, batch := range page.Data {
		fmt.Println(batch.ID)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}

RequestOptions

このライブラリは関数型オプションパターンを使用します。optionパッケージで定義された関数はRequestOptionを返します。これはRequestConfigを変更するクロージャです。これらのオプションは、クライアントまたは個々のリクエストに指定できます。例:

client := anthropic.NewClient(
	// クライアントが行うすべてのリクエストにヘッダーを追加します
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Messages.New(context.TODO(), // ...,
	// ヘッダーを上書きします
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// sjson構文を使用して、ドキュメント化されていないフィールドをリクエストボディに追加します
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

リクエストオプションoption.WithDebugLog(nil)は、デバッグ中に役立つ場合があります。

リクエストオプションの完全なリストを参照してください。

HTTPクライアントのカスタマイズ

リクエストミドルウェア(option.WithMiddleware)およびデフォルトのhttp.Clientの置き換え(option.WithHTTPClient)については、SDKミドルウェアを参照してください。

プラットフォーム統合

Go SDKは以下のプラットフォームをサポートしています:

  • Agent Platform: import "github.com/anthropics/anthropic-sdk-go/vertex"vertex.WithGoogleAuth(ctx, region, projectID)またはvertex.WithCredentials(ctx, region, projectID, creds)を使用します。
  • Bedrock: import "github.com/anthropics/anthropic-sdk-go/bedrock"。Messages-API Bedrockエンドポイント(SSE経由でストリーミング)にはbedrock.NewMantleClientを使用するか、bedrock.WithLoadDefaultConfig(ctx) / bedrock.WithConfig(cfg)bedrock-runtimeパス)を使用します。bedrockパッケージをインポートすると、application/vnd.amazon.eventstream用のデコーダーがSDKのストリーミングレイヤーにグローバルに登録されます(パッケージのinit()を通じて)。これは、bedrock-runtimeWithConfig/WithLoadDefaultConfigパスを使用する場合でも、NewMantleClientを使用する場合でも適用されます。
  • Claude Platform on AWS: import anthropicaws "github.com/anthropics/anthropic-sdk-go/aws"anthropicaws.ClientConfig値とともにanthropicaws.NewClient(ctx, cfg)を使用してクライアントを構築します。configのWorkspaceIDまたはANTHROPIC_AWS_WORKSPACE_ID環境変数を設定してください。anthropicawsインポートエイリアスは、両方をインポートする場合にgithub.com/aws/aws-sdk-go-v2/awsとの名前の衝突を回避します。ベータ版で利用可能です。
  • Foundry: 現在Go SDKではサポートされていません。サポートされているSDKについては、Claude in Microsoft Foundryを参照してください。

新しいプロジェクトにはbedrock.NewMantleClientを使用してください。bedrock.WithLoadDefaultConfig/WithConfigは、Bedrock InvokeModel APIを使用する既存のアプリケーション向けに引き続き提供されます。

高度な使用方法

生のレスポンスデータへのアクセス(例:レスポンスヘッダー)

option.WithResponseInto()リクエストオプションを使用して、生のHTTPレスポンスデータにアクセスできます。これは、レスポンスヘッダー、ステータスコード、またはその他の詳細を調べる必要がある場合に便利です。

// HTTPレスポンスを格納する変数を作成
var response *http.Response
message, err := client.Messages.New(
	context.TODO(),
	anthropic.MessageNewParams{
		MaxTokens: 1024,
		Messages: []anthropic.MessageParam{{
			Content: []anthropic.ContentBlockParamUnion{{
				OfText: &anthropic.TextBlockParam{
					Text: "What is a quaternion?",
				},
			}},
			Role: anthropic.MessageParamRoleUser,
		}},
		Model: anthropic.ModelClaudeOpus5,
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// エラーを処理
}
fmt.Printf("%+v\n", message.Content)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)

カスタム/ドキュメント化されていないリクエストの実行

このライブラリは、ドキュメント化されたAPIに便利にアクセスできるように型付けされています。ドキュメント化されていないエンドポイント、パラメータ、またはレスポンスプロパティにアクセスする必要がある場合でも、このライブラリを使用できます。

ドキュメント化されていないエンドポイント

ドキュメント化されていないエンドポイントにリクエストを行うには、client.Getclient.Post、およびその他のHTTP動詞を使用できます。 これらのリクエストを行う際、リトライなどのクライアントのRequestOptionsは尊重されます。

var (
	// paramsにはio.Reader、[]byte、encoding/jsonでシリアライズ可能なオブジェクト、
	// またはこのライブラリで定義された"...Params"構造体を指定できます。
	params map[string]any

	// resultには[]byte、*http.Response、encoding/jsonでデシリアライズ可能なオブジェクト、
	// またはこのライブラリで定義されたモデルを指定できます。
	result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
	// ...
}

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないパラメータを使用してリクエストを行うには、option.WithQuerySet()またはoption.WithJSONSet()メソッドのいずれかを使用できます。

params := FooNewParams{
	ID: "id_xxxx",
	Data: FooNewParamsData{
		FirstName: anthropic.String("John"),
	},
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))

ドキュメント化されていないレスポンスプロパティ

ドキュメント化されていないレスポンスプロパティにアクセスするには、result.JSON.RawJSON()でレスポンスの生のJSONを文字列としてアクセスするか、result.JSON.Foo.Raw()で結果の特定のフィールドの生のJSONを取得できます。

レスポンスstructに存在しないフィールドはすべて保存され、map[string]respjson.Fieldであるresult.JSON.ExtraFieldsを通じてアクセスできます。

セマンティックバージョニング

このパッケージは概ねSemVerの規約に従っていますが、特定の後方互換性のない変更がマイナーバージョンとしてリリースされる場合があります:

  1. 技術的には公開されているが、外部での使用を意図またはドキュメント化していないライブラリ内部への変更。
  2. 実際には大多数のユーザーに影響を与えないと予想される変更。

スムーズなアップグレード体験を確実に提供できるよう、後方互換性は真剣に考慮されています。

フィードバックを歓迎します。質問、バグ、または提案がある場合はissueを作成してください。

追加リソース

Was this page helpful?