Options - Go SDK

Global Options

Global options are passed when initializing the SDK client and apply to all operations.

WithServerURL

WithServerURL allows providing an alternative server URL.

1
openrouter.WithServerURL("https://api.example.com")

WithTemplatedServerURL

WithTemplatedServerURL allows providing an alternative server URL with templated parameters.

1
openrouter.WithTemplatedServerURL("https://{host}:{port}", map[string]string{
2
    "host": "api.example.com",
3
    "port": "8080",
4
})

WithServer

WithServer allows the overriding of the default server by name.

1
openrouter.WithServer("my-server")

WithClient

WithClient allows the overriding of the default HTTP client used by the SDK.

1
openrouter.WithClient(httpClient)

WithSecurity

WithSecurity configures the SDK to use the provided security details.

1
openrouter.WithSecurity(/* ... */)

WithSecuritySource

WithSecuritySource configures the SDK to invoke the provided function on each method call to determine authentication.

1
openrouter.WithSecuritySource(/* ... */)

WithHTTPReferer

WithHTTPReferer allows setting the HTTPReferer parameter for all supported operations.

1
openrouter.WithHTTPReferer(/* ... */)

WithXTitle

WithXTitle allows setting the XTitle parameter for all supported operations.

1
openrouter.WithXTitle(/* ... */)

WithRetryConfig

WithRetryConfig allows setting the default retry configuration used by the SDK for all supported operations.

1
openrouter.WithRetryConfig(retry.Config{
2
    Strategy: "backoff",
3
    Backoff: retry.BackoffStrategy{
4
        InitialInterval: 500 * time.Millisecond,
5
        MaxInterval: 60 * time.Second,
6
        Exponent: 1.5,
7
        MaxElapsedTime: 5 * time.Minute,
8
    },
9
    RetryConnectionErrors: true,
10
})

WithTimeout

WithTimeout sets the default request timeout for all operations.

1
openrouter.WithTimeout(30 * time.Second)

Per-Method Options

Per-method options are passed as the last argument to individual methods and override any global settings for that request.

WithServerURL

WithServerURL allows providing an alternative server URL for a single request.

1
operations.WithServerURL("http://api.example.com")

WithTemplatedServerURL

WithTemplatedServerURL allows providing an alternative server URL with templated parameters for a single request.

1
operations.WithTemplatedServerURL("http://{host}:{port}", map[string]string{
2
    "host": "api.example.com",
3
    "port": "8080",
4
})

WithRetries

WithRetries allows customizing the default retry configuration for a single request.

1
operations.WithRetries(retry.Config{
2
    Strategy: "backoff",
3
    Backoff: retry.BackoffStrategy{
4
        InitialInterval: 500 * time.Millisecond,
5
        MaxInterval: 60 * time.Second,
6
        Exponent: 1.5,
7
        MaxElapsedTime: 5 * time.Minute,
8
    },
9
    RetryConnectionErrors: true,
10
})

WithOperationTimeout

WithOperationTimeout allows setting the request timeout for a single request.

1
operations.WithOperationTimeout(30 * time.Second)

WithSetHeaders

WithSetHeaders allows setting custom headers on a per-request basis. If the request already contains headers matching the provided keys, they will be overwritten.

1
operations.WithSetHeaders(map[string]string{
2
    "X-Cache-TTL": "60",
3
})

WithURLOverride

WithURLOverride allows overriding the default URL for an operation.

1
operations.WithURLOverride("/custom/path")

WithAcceptHeaderOverride

WithAcceptHeaderOverride allows overriding the Accept header for operations that support multiple response content types.

1
operations.WithAcceptHeaderOverride(operations.AcceptHeaderEnumApplicationJson)