https://github.com/imagekit-developer/imagekit-go
Go SDK for ImageKit.io API.
https://github.com/imagekit-developer/imagekit-go
Last synced: 12 days ago
JSON representation
Go SDK for ImageKit.io API.
- Host: GitHub
- URL: https://github.com/imagekit-developer/imagekit-go
- Owner: imagekit-developer
- License: apache-2.0
- Created: 2022-06-15T06:40:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-01-28T16:36:20.000Z (17 days ago)
- Last Synced: 2026-01-28T23:43:52.122Z (17 days ago)
- Language: Go
- Size: 2.72 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ImageKit.io Go SDK
The ImageKit Go SDK is a comprehensive library designed to simplify the integration of ImageKit into your server-side applications. It provides powerful tools for working with the ImageKit REST API, including building and transforming URLs, generating signed URLs for secure content delivery, verifying webhooks, and handling file uploads.
The full API of this library can be found in [api.md](api.md).
For additional details, refer to the [ImageKit REST API documentation](https://imagekit.io/docs/api-reference).
## Table of Contents
- [Installation](#installation)
- [Requirements](#requirements)
- [Usage](#usage)
- [Request fields](#request-fields)
- [Request unions](#request-unions)
- [Response objects](#response-objects)
- [Response Unions](#response-unions)
- [RequestOptions](#requestoptions)
- [URL generation](#url-generation)
- [Basic URL generation](#basic-url-generation)
- [URL generation with transformations](#url-generation-with-transformations)
- [URL generation with image overlay](#url-generation-with-image-overlay)
- [URL generation with text overlay](#url-generation-with-text-overlay)
- [URL generation with multiple overlays](#url-generation-with-multiple-overlays)
- [Signed URLs for secure delivery](#signed-urls-for-secure-delivery)
- [Authentication parameters for client-side uploads](#authentication-parameters-for-client-side-uploads)
- [Webhook verification](#webhook-verification)
- [Advanced Usage](#advanced-usage)
- [Errors](#errors)
- [Timeouts](#timeouts)
- [File uploads](#file-uploads)
- [Retries](#retries)
- [Accessing raw response data](#accessing-raw-response-data-eg-response-headers)
- [Making custom/undocumented requests](#making-customundocumented-requests)
- [Middleware](#middleware)
- [Semantic versioning](#semantic-versioning)
- [Contributing](#contributing)
## Installation
```go
import (
"github.com/imagekit-developer/imagekit-go/v2" // imported as imagekit
)
```
Or to pin the version:
```sh
go get -u 'github.com/imagekit-developer/imagekit-go/v2@v2.2.0'
```
## Requirements
This library requires Go 1.22+.
## Usage
The full API of this library can be found in [api.md](api.md).
```go
package main
import (
"context"
"fmt"
"os"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"), // defaults to os.LookupEnv("IMAGEKIT_PRIVATE_KEY")
)
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
}
```
### Request fields
The imagekit library uses the [`omitzero`](https://tip.golang.org/doc/go1.24#encodingjsonpkgencodingjson)
semantics from the Go 1.24+ `encoding/json` release for request fields.
Required primitive fields (`int64`, `string`, etc.) feature the tag \`json:"...,required"\`. These
fields are always serialized, even their zero values.
Optional primitive types are wrapped in a `param.Opt[T]`. These fields can be set with the provided constructors, `imagekit.String(string)`, `imagekit.Int(int64)`, etc.
Any `param.Opt[T]`, map, slice, struct or string enum uses the
tag \`json:"...,omitzero"\`. Its zero value is considered omitted.
The `param.IsOmitted(any)` function can confirm the presence of any `omitzero` field.
```go
p := imagekit.ExampleParams{
ID: "id_xxx", // required property
Name: imagekit.String("..."), // optional property
Point: imagekit.Point{
X: 0, // required field will serialize as 0
Y: imagekit.Int(1), // optional field will serialize as 1
// ... omitted non-required fields will not be serialized
},
Origin: imagekit.Origin{}, // the zero value of [Origin] is considered omitted
}
```
To send `null` instead of a `param.Opt[T]`, use `param.Null[T]()`.
To send `null` instead of a struct `T`, use `param.NullStruct[T]()`.
```go
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
```
Request structs contain a `.SetExtraFields(map[string]any)` method which can send non-conforming
fields in the request body. Extra fields overwrite any struct fields with a matching
key. For security reasons, only use `SetExtraFields` with trusted data.
To send a custom value instead of a struct, use `param.Override[T](value)`.
```go
// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
"x": 0.01, // send "x" as a float instead of int
})
// Send a number instead of an object
custom := param.Override[imagekit.FooParams](12)
```
### Request unions
Unions are represented as a struct with fields prefixed by "Of" for each of its variants,
only one field can be non-zero. The non-zero field will be serialized.
Sub-properties of the union can be accessed via methods on the union struct.
These methods return a mutable pointer to the underlying data, if present.
```go
// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
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", Zip: 0},
},
},
}
// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
address.ZipCode = 94304
}
```
### Response objects
All fields in response structs are ordinary value types (not pointers or wrappers).
Response structs also include a special `JSON` field containing metadata about
each property.
```go
type Animal struct {
Name string `json:"name,nullable"`
Owners int `json:"owners"`
Age int `json:"age"`
JSON struct {
Name respjson.Field
Owner respjson.Field
Age respjson.Field
ExtraFields map[string]respjson.Field
} `json:"-"`
}
```
To handle optional data, use the `.Valid()` method on the JSON field.
`.Valid()` returns true if a field is not `null`, not present, or couldn't be marshaled.
If `.Valid()` is false, the corresponding field will simply be its zero value.
```go
raw := `{"owners": 1, "name": null}`
var res Animal
json.Unmarshal([]byte(raw), &res)
// Accessing regular fields
res.Owners // 1
res.Name // ""
res.Age // 0
// Optional field checks
res.JSON.Owners.Valid() // true
res.JSON.Name.Valid() // false
res.JSON.Age.Valid() // false
// Raw JSON values
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
```
These `.JSON` structs also include an `ExtraFields` map containing
any properties in the json response that were not specified
in the struct. This can be useful for API features not yet
present in the SDK.
```go
body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
```
### Response Unions
In responses, unions are represented by a flattened struct containing all possible fields from each of the
object variants.
To convert it to a variant use the `.AsFooVariant()` method or the `.AsAny()` method if present.
If a response value union contains primitive values, primitive fields will be alongside
the properties but prefixed with `Of` and feature the tag `json:"...,inline"`.
```go
type AnimalUnion struct {
// From variants [Dog], [Cat]
Owner Person `json:"owner"`
// From variant [Dog]
DogBreed string `json:"dog_breed"`
// From variant [Cat]
CatBreed string `json:"cat_breed"`
// ...
JSON struct {
Owner respjson.Field
// ...
} `json:"-"`
}
// If animal variant
if animal.Owner.Address.ZipCode == "" {
panic("missing zip code")
}
// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
panic("unexpected type")
}
```
### RequestOptions
This library uses the functional options pattern. Functions defined in the
`option` package return a `RequestOption`, which is a closure that mutates a
`RequestConfig`. These options can be supplied to the client or at individual
requests. For example:
```go
client := imagekit.NewClient(
// Adds a header to every request made by the client
option.WithHeader("X-Some-Header", "custom_header_info"),
)
client.Files.Upload(context.TODO(), ...,
// Override the header
option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
// Add an undocumented field to the request body, using sjson syntax
option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)
```
The request option `option.WithDebugLog(nil)` may be helpful while debugging.
See the [full list of request options](https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/option).
## URL generation
The ImageKit SDK provides a powerful `Helper.BuildURL()` method for generating optimized image and video URLs with transformations. Here are examples ranging from simple URLs to complex transformations with overlays and signed URLs.
### Basic URL generation
Generate a simple URL without any transformations:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/shared"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// Basic URL without transformations
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/image.jpg",
})
fmt.Println(url)
// Result: https://ik.imagekit.io/your_imagekit_id/path/to/image.jpg
}
```
### URL generation with transformations
Apply common transformations like resizing, cropping, and format conversion:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// URL with basic transformations
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/image.jpg",
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 400},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 300},
},
Crop: shared.TransformationCropMaintainRatio,
Quality: param.Opt[float64]{Value: 80},
Format: shared.TransformationFormatWebp,
},
},
})
fmt.Println(url)
// Result: https://ik.imagekit.io/your_imagekit_id/path/to/image.jpg?tr=w-400,h-300,c-maintain_ratio,q-80,f-webp
}
```
### URL generation with image overlay
Add image overlays to your base image:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
"github.com/imagekit-developer/imagekit-go/v2/shared/constant"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// URL with image overlay
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/base-image.jpg",
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 500},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 400},
},
Overlay: shared.OverlayUnionParam{
OfImage: &shared.ImageOverlayParam{
Type: constant.Image("image"),
Input: "/path/to/overlay-logo.png",
BaseOverlayParam: shared.BaseOverlayParam{
Position: shared.OverlayPositionParam{
X: shared.OverlayPositionXUnionParam{
OfFloat: param.Opt[float64]{Value: 10},
},
Y: shared.OverlayPositionYUnionParam{
OfFloat: param.Opt[float64]{Value: 10},
},
},
},
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 100},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 50},
},
},
},
},
},
},
},
})
fmt.Println(url)
// Result: URL with image overlay positioned at x:10, y:10
}
```
### URL generation with text overlay
Add customized text overlays:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
"github.com/imagekit-developer/imagekit-go/v2/shared/constant"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// URL with text overlay
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/base-image.jpg",
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 600},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 400},
},
Overlay: shared.OverlayUnionParam{
OfText: &shared.TextOverlayParam{
Type: constant.Text("text"),
Text: "Sample Text Overlay",
BaseOverlayParam: shared.BaseOverlayParam{
Position: shared.OverlayPositionParam{
X: shared.OverlayPositionXUnionParam{
OfFloat: param.Opt[float64]{Value: 50},
},
Y: shared.OverlayPositionYUnionParam{
OfFloat: param.Opt[float64]{Value: 50},
},
Focus: shared.OverlayPositionFocusCenter,
},
},
Transformation: []shared.TextOverlayTransformationParam{
{
FontSize: shared.TextOverlayTransformationFontSizeUnionParam{
OfFloat: param.Opt[float64]{Value: 40},
},
FontFamily: param.Opt[string]{Value: "Arial"},
FontColor: param.Opt[string]{Value: "FFFFFF"},
Typography: param.Opt[string]{Value: "b"}, // bold
},
},
},
},
},
},
})
fmt.Println(url)
// Result: URL with bold white Arial text overlay at center position
}
```
### URL generation with multiple overlays
Combine multiple overlays for complex compositions:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
"github.com/imagekit-developer/imagekit-go/v2/shared/constant"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// URL with multiple overlays (text + image)
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/base-image.jpg",
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 800},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 600},
},
Overlay: shared.OverlayUnionParam{
OfText: &shared.TextOverlayParam{
Type: constant.Text("text"),
Text: "Header Text",
BaseOverlayParam: shared.BaseOverlayParam{
Position: shared.OverlayPositionParam{
X: shared.OverlayPositionXUnionParam{
OfFloat: param.Opt[float64]{Value: 20},
},
Y: shared.OverlayPositionYUnionParam{
OfFloat: param.Opt[float64]{Value: 20},
},
},
},
Transformation: []shared.TextOverlayTransformationParam{
{
FontSize: shared.TextOverlayTransformationFontSizeUnionParam{
OfFloat: param.Opt[float64]{Value: 30},
},
FontColor: param.Opt[string]{Value: "000000"},
},
},
},
},
},
{
Overlay: shared.OverlayUnionParam{
OfImage: &shared.ImageOverlayParam{
Type: constant.Image("image"),
Input: "/watermark.png",
BaseOverlayParam: shared.BaseOverlayParam{
Position: shared.OverlayPositionParam{
Focus: shared.OverlayPositionFocusBottomRight,
},
},
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 100},
},
Opacity: param.Opt[float64]{Value: 70},
},
},
},
},
},
},
})
fmt.Println(url)
// Result: URL with text overlay at top-left and semi-transparent watermark at bottom-right
}
```
### Signed URLs for secure delivery
Generate signed URLs that expire after a specified time for secure content delivery:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// Generate a signed URL that expires in 1 hour (3600 seconds)
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/private/secure-image.jpg",
Transformation: []shared.TransformationParam{
{
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 400},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 300},
},
Quality: param.Opt[float64]{Value: 90},
},
},
Signed: param.Opt[bool]{Value: true},
ExpiresIn: param.Opt[float64]{Value: 3600}, // URL expires in 1 hour
})
fmt.Println(url)
// Result: URL with signature parameters (?ik-t=timestamp&ik-s=signature)
// Generate a signed URL that doesn't expire
permanentSignedUrl := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/private/secure-image.jpg",
Signed: param.Opt[bool]{Value: true},
// No ExpiresIn means the URL won't expire
})
fmt.Println(permanentSignedUrl)
// Result: URL with signature parameter (?ik-s=signature)
}
```
### Using Raw transformations for undocumented features
ImageKit frequently adds new transformation parameters that might not yet be documented in the SDK. You can use the `Raw` parameter to access these features or create custom transformation strings:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/shared"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// Using Raw transformation for undocumented or new parameters
url := client.Helper.BuildURL(shared.SrcOptionsParam{
URLEndpoint: "https://ik.imagekit.io/your_imagekit_id",
Src: "/path/to/image.jpg",
Transformation: []shared.TransformationParam{
{
// Combine documented transformations with raw parameters
Width: shared.TransformationWidthUnionParam{
OfFloat: param.Opt[float64]{Value: 400},
},
Height: shared.TransformationHeightUnionParam{
OfFloat: param.Opt[float64]{Value: 300},
},
},
{
// Use Raw for undocumented transformations or complex parameters
Raw: param.Opt[string]{Value: "something-new"},
},
},
})
fmt.Println(url)
// Result: https://ik.imagekit.io/your_imagekit_id/path/to/image.jpg?tr=w-400,h-300:something-new
}
```
## Authentication parameters for client-side uploads
Generate authentication parameters for secure client-side file uploads:
```go
package main
import (
"fmt"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("private_key_xxx"),
)
// Generate authentication parameters for client-side uploads
authParams := client.Helper.GetAuthenticationParameters("", 0)
fmt.Printf("%+v\n", authParams)
// Result: map[expire: signature: token:]
// Generate with custom token and expiry
customAuthParams := client.Helper.GetAuthenticationParameters("my-custom-token", 1800)
fmt.Printf("%+v\n", customAuthParams)
// Result: map[expire:1800 signature: token:my-custom-token]
}
```
These authentication parameters can be used in client-side upload forms to securely upload files without exposing your private API key.
## Webhook verification
The ImageKit SDK provides utilities to verify webhook signatures for secure event handling. This ensures that webhook requests are actually coming from ImageKit and haven't been tampered with.
### Verifying webhook signatures
```go
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
"github.com/imagekit-developer/imagekit-go/v2"
"github.com/imagekit-developer/imagekit-go/v2/option"
)
func main() {
client := imagekit.NewClient(
option.WithPrivateKey("your_private_key"),
option.WithWebhookSecret("whsec_..."), // Copy from ImageKit dashboard
)
// Webhook handler with proper request body handling
http.HandleFunc("/webhook", func(w http.ResponseWriter, req *http.Request) {
// Limit request body size to prevent abuse (64KB should be sufficient for most webhooks)
const MaxBodyBytes = int64(65536)
req.Body = http.MaxBytesReader(w, req.Body, MaxBodyBytes)
// Read the raw webhook payload
payload, err := io.ReadAll(req.Body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error reading request body: %v\n", err)
w.WriteHeader(http.StatusServiceUnavailable)
return
}
// Verify and unwrap webhook payload
event, err := client.Webhooks.Unwrap(payload, req.Header)
if err != nil {
fmt.Fprintf(os.Stderr, "Invalid webhook signature or malformed payload: %v\n", err)
w.WriteHeader(http.StatusUnauthorized)
return
}
fmt.Printf("Verified webhook event: %s\n", event.Type)
// Handle different event types with full type safety
switch event.Type {
case "video.transformation.accepted":
videoEvent := event.AsVideoTransformationAcceptedEvent()
fmt.Printf("Video transformation accepted: %s\n", videoEvent.Data.Asset.URL)
// Debugging: Track transformation requests
// handleVideoTransformationAccepted(videoEvent)
case "video.transformation.ready":
videoEvent := event.AsVideoTransformationReadyEvent()
fmt.Printf("Video transformation ready: %s\n", videoEvent.Data.Transformation.Output.URL)
// Update your database/CMS to show the transformed video
// handleVideoTransformationReady(videoEvent)
case "video.transformation.error":
videoEvent := event.AsVideoTransformationErrorEvent()
fmt.Printf("Video transformation error: %s\n", videoEvent.Data.Transformation.Error.Reason)
// Log error and check your origin/URL endpoint settings
// handleVideoTransformationError(videoEvent)
case "upload.pre-transform.success":
uploadEvent := event.AsUploadPreTransformSuccessEvent()
fmt.Printf("Pre-transform success: %s\n", uploadEvent.Data.FileID)
// File uploaded and pre-transformation completed
// handleUploadPreTransformSuccess(uploadEvent)
case "upload.post-transform.success":
postEvent := event.AsUploadPostTransformSuccessEvent()
fmt.Printf("Post-transform success: %s\n", postEvent.Data.Name)
// Additional transformation completed
// handleUploadPostTransformSuccess(postEvent)
// Handle other event types as needed
default:
fmt.Printf("Unhandled event type: %s\n", event.Type)
}
w.WriteHeader(http.StatusOK)
})
// Start the server
fmt.Println("Webhook server listening on :8080")
log.Fatal(http.ListenAndServe(":8080", nil))
}
```
For detailed information about webhook setup, signature verification, and handling different webhook events, refer to the [ImageKit webhook documentation](https://imagekit.io/docs/webhooks#verify-webhook-signature).
### Errors
When the API returns a non-success status code, we return an error with type
`*imagekit.Error`. This contains the `StatusCode`, `*http.Request`, and
`*http.Response` values of the request, as well as the JSON of the error body
(much like other response objects in the SDK).
To handle errors, we recommend that you use the `errors.As` pattern:
```go
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
_, err = client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
})
if err != nil {
var apierr *imagekit.Error
if errors.As(err, &apierr) {
println(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request
println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
}
panic(err.Error()) // GET "/api/v1/files/upload": 400 Bad Request { ... }
}
```
When other errors occur, they are returned unwrapped; for example,
if HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.
### Timeouts
Requests do not time out by default; use context to configure a timeout for a request lifecycle.
Note that if a request is [retried](#retries), the context timeout does not start over.
To set a per-retry timeout, use `option.WithRequestTimeout()`.
```go
// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
client.Files.Upload(
ctx,
imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
},
// This sets the per-retry timeout
option.WithRequestTimeout(20*time.Second),
)
```
### File uploads
Request parameters that correspond to file uploads in multipart requests are typed as
`io.Reader`. The contents of the `io.Reader` will by default be sent as a multipart form
part with the file name of "anonymous_file" and content-type of "application/octet-stream".
The file name and content-type can be customized by implementing `Name() string` or `ContentType()
string` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a
file returned by `os.Open` will be sent with the file name on disk.
We also provide a helper `imagekit.NewFile(reader io.Reader, filename string, contentType string)`
which can be used to wrap any `io.Reader` with the appropriate file name and content type.
Here are common file upload patterns:
```go
// Upload from local file system
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
})
// Upload from remote URL
resp, err := http.Get("https://example.com/remote-image.jpg")
if err != nil {
panic(err.Error())
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
panic("Failed to fetch remote image")
}
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: resp.Body,
FileName: "remote-image.jpg",
})
// Upload from binary data
imageData := []byte{/* your binary data */}
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: bytes.NewReader(imageData),
FileName: "binary-upload.jpg",
})
// Upload with custom content type
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
File: imagekit.NewFile(bytes.NewReader(imageData), "custom.jpg", "image/jpeg"),
FileName: "custom-upload.jpg",
})
```
### Retries
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,
and >=500 Internal errors.
You can use the `WithMaxRetries` option to configure or disable this:
```go
// Configure the default for all requests:
client := imagekit.NewClient(
option.WithMaxRetries(0), // default is 2
)
// Override per-request:
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
client.Files.Upload(
context.TODO(),
imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
},
option.WithMaxRetries(5),
)
```
### Accessing raw response data (e.g. response headers)
You can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when
you need to examine response headers, status codes, or other details.
```go
// Create a variable to store the HTTP response
var response *http.Response
file, err := os.Open("/path/to/your/image.jpg")
if err != nil {
panic(err.Error())
}
defer file.Close()
response, err = client.Files.Upload(
context.TODO(),
imagekit.FileUploadParams{
File: file,
FileName: "uploaded-image.jpg",
},
option.WithResponseInto(&response),
)
if err != nil {
// handle error
}
fmt.Printf("%+v\n", response)
fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
```
### Making custom/undocumented requests
This library is typed for convenient access to the documented API. If you need to access undocumented
endpoints, params, or response properties, the library can still be used.
#### Undocumented endpoints
To make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.
`RequestOptions` on the client, such as retries, will be respected when making these requests.
```go
var (
// params can be an io.Reader, a []byte, an encoding/json serializable object,
// or a "…Params" struct defined in this library.
params map[string]any
// result can be an []byte, *http.Response, a encoding/json deserializable object,
// or a model defined in this library.
result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
…
}
```
#### Undocumented request params
To make requests using undocumented parameters, you may use either the `option.WithQuerySet()`
or the `option.WithJSONSet()` methods.
```go
params := FooNewParams{
ID: "id_xxxx",
Data: FooNewParamsData{
FirstName: imagekit.String("John"),
},
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
```
#### Undocumented response properties
To access undocumented response properties, you may either access the raw JSON of the response as a string
with `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with
`result.JSON.Foo.Raw()`.
Any fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.
### Middleware
We provide `option.WithMiddleware` which applies the given
middleware to requests.
```go
func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
// Before the request
start := time.Now()
LogReq(req)
// Forward the request to the next handler
res, err = next(req)
// Handle stuff after the request
end := time.Now()
LogRes(res, err, start - end)
return res, err
}
client := imagekit.NewClient(
option.WithMiddleware(Logger),
)
```
When multiple middlewares are provided as variadic arguments, the middlewares
are applied left to right. If `option.WithMiddleware` is given
multiple times, for example first in the client then the method, the
middleware in the client will run first and the middleware given in the method
will run next.
You may also replace the default `http.Client` with
`option.WithHTTPClient(client)`. Only one http client is
accepted (this overwrites any previous client) and receives requests after any
middleware has been applied.
## Semantic versioning
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
2. Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an [issue](https://www.github.com/imagekit-developer/imagekit-go/issues) with questions, bugs, or suggestions.
## Contributing
See [the contributing documentation](./CONTRIBUTING.md).