Images - Go SDK

Images method reference

The Go SDK and docs are currently in beta. Report issues on GitHub.

Overview

Images endpoints

Available Operations

Generate

Generates an image from a text prompt via the image generation router

Example Usage

1package main
2
3import(
4 "context"
5 "os"
6 openrouter "github.com/OpenRouterTeam/go-sdk"
7 "github.com/OpenRouterTeam/go-sdk/models/components"
8 "log"
9)
10
11func main() {
12 ctx := context.Background()
13
14 s := openrouter.New(
15 openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
16 )
17
18 res, err := s.Images.Generate(ctx, components.ImageGenerationRequest{
19 Model: "bytedance-seed/seedream-4.5",
20 Prompt: "a red panda astronaut floating in space, studio lighting",
21 })
22 if err != nil {
23 log.Fatal(err)
24 }
25 if res != nil {
26 defer res.ImageStreamingResponse.Close()
27
28 for res.ImageStreamingResponse.Next() {
29 event := res.ImageStreamingResponse.Value()
30 log.Print(event)
31 // Handle the event
32 }
33 }
34}

Parameters

ParameterTypeRequiredDescription
ctxcontext.Context✔️The context to use for the request.
requestcomponents.ImageGenerationRequest✔️The request object to use for the request.
opts[]operations.OptionThe options for this request.

Response

*operations.CreateImagesResponse, error

Errors

Error TypeStatus CodeContent Type
sdkerrors.BadRequestResponseError400application/json
sdkerrors.UnauthorizedResponseError401application/json
sdkerrors.PaymentRequiredResponseError402application/json
sdkerrors.ForbiddenResponseError403application/json
sdkerrors.NotFoundResponseError404application/json
sdkerrors.TooManyRequestsResponseError429application/json
sdkerrors.InternalServerResponseError500application/json
sdkerrors.BadGatewayResponseError502application/json
sdkerrors.EdgeNetworkTimeoutResponseError524application/json
sdkerrors.ProviderOverloadedResponseError529application/json
sdkerrors.APIError4XX, 5XX*/*

ListModels

Lists every image generation model with its top-level supported-parameter superset and a URL to its full per-endpoint records.

Example Usage

1package main
2
3import(
4 "context"
5 "os"
6 openrouter "github.com/OpenRouterTeam/go-sdk"
7 "log"
8)
9
10func main() {
11 ctx := context.Background()
12
13 s := openrouter.New(
14 openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
15 )
16
17 res, err := s.Images.ListModels(ctx)
18 if err != nil {
19 log.Fatal(err)
20 }
21 if res != nil {
22 // handle response
23 }
24}

Parameters

ParameterTypeRequiredDescription
ctxcontext.Context✔️The context to use for the request.
opts[]operations.OptionThe options for this request.

Response

*components.ImageModelsListResponse, error

Errors

Error TypeStatus CodeContent Type
sdkerrors.InternalServerResponseError500application/json
sdkerrors.APIError4XX, 5XX*/*

ListModelEndpoints

Returns the full per-endpoint records for an image model: each endpoint’s definitive supported parameters, pricing, and passthrough allowlist.

Example Usage

1package main
2
3import(
4 "context"
5 "os"
6 openrouter "github.com/OpenRouterTeam/go-sdk"
7 "log"
8)
9
10func main() {
11 ctx := context.Background()
12
13 s := openrouter.New(
14 openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
15 )
16
17 res, err := s.Images.ListModelEndpoints(ctx, "bytedance-seed", "seedream-4.5")
18 if err != nil {
19 log.Fatal(err)
20 }
21 if res != nil {
22 // handle response
23 }
24}

Parameters

ParameterTypeRequiredDescriptionExample
ctxcontext.Context✔️The context to use for the request.
authorstring✔️Model author/organizationbytedance-seed
slugstring✔️Model slugseedream-4.5
opts[]operations.OptionThe options for this request.

Response

*components.ImageModelEndpointsResponse, error

Errors

Error TypeStatus CodeContent Type
sdkerrors.NotFoundResponseError404application/json
sdkerrors.InternalServerResponseError500application/json
sdkerrors.APIError4XX, 5XX*/*